The type of interface endpoint.
", - "smithy.api#required": {} - } - }, - "VpceId": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The identifier (ID) of the VPC in which the interface endpoint is used.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
" - } - }, - "com.amazonaws.appstream#AccessEndpointList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#AccessEndpoint" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.appstream#AccessEndpointType": { - "type": "enum", - "members": { - "STREAMING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STREAMING" - } - } - } - }, - "com.amazonaws.appstream#AccountName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.appstream#AccountPassword": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 127 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.appstream#Action": { - "type": "enum", - "members": { - "CLIPBOARD_COPY_FROM_LOCAL_DEVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLIPBOARD_COPY_FROM_LOCAL_DEVICE" - } - }, - "CLIPBOARD_COPY_TO_LOCAL_DEVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLIPBOARD_COPY_TO_LOCAL_DEVICE" - } - }, - "FILE_UPLOAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILE_UPLOAD" - } - }, - "FILE_DOWNLOAD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILE_DOWNLOAD" - } - }, - "PRINTING_TO_LOCAL_DEVICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRINTING_TO_LOCAL_DEVICE" - } - }, - "DOMAIN_PASSWORD_SIGNIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_PASSWORD_SIGNIN" - } - }, - "DOMAIN_SMART_CARD_SIGNIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_SMART_CARD_SIGNIN" - } - } - } - }, - "com.amazonaws.appstream#AppBlock": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block.
", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the app block.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The description of the app block.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The display name of the app block.
" - } - }, - "SourceS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#documentation": "The source S3 location of the app block.
" - } - }, - "SetupScriptDetails": { - "target": "com.amazonaws.appstream#ScriptDetails", - "traits": { - "smithy.api#documentation": "The setup script details of the app block.
\nThis only applies to app blocks with PackagingType CUSTOM.
The created time of the app block.
" - } - }, - "PostSetupScriptDetails": { - "target": "com.amazonaws.appstream#ScriptDetails", - "traits": { - "smithy.api#documentation": "The post setup script details of the app block.
\nThis only applies to app blocks with PackagingType APPSTREAM2.
The packaging type of the app block.
" - } - }, - "State": { - "target": "com.amazonaws.appstream#AppBlockState", - "traits": { - "smithy.api#documentation": "The state of the app block.
\nAn app block with AppStream 2.0 packaging will be in the INACTIVE state\n if no application package (VHD) is assigned to it. After an application package (VHD) is\n created by an app block builder for an app block, it becomes ACTIVE.
Custom app blocks are always in the ACTIVE state and no action is required to use them.
The errors of the app block.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an app block.
\nApp blocks are an Amazon AppStream 2.0 resource that stores the details about the\n virtual hard disk in an S3 bucket. It also stores the setup script with details about\n how to mount the virtual hard disk. The virtual hard disk includes the application\n binaries and other files necessary to launch your applications. Multiple applications\n can be assigned to a single app block.
\nThis is only supported for Elastic fleets.
" - } - }, - "com.amazonaws.appstream#AppBlockBuilder": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the app block builder.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The display name of the app block builder.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The description of the app block builder.
" - } - }, - "Platform": { - "target": "com.amazonaws.appstream#AppBlockBuilderPlatformType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The platform of the app block builder.
\n\n WINDOWS_SERVER_2019 is the only valid value.
The instance type of the app block builder.
", - "smithy.api#required": {} - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Indicates whether default internet access is enabled for the app block builder.
" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM role that is applied to the app block builder.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The VPC configuration for the app block builder.
", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.appstream#AppBlockBuilderState", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The state of the app block builder.
", - "smithy.api#required": {} - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The creation time of the app block builder.
" - } - }, - "AppBlockBuilderErrors": { - "target": "com.amazonaws.appstream#ResourceErrors", - "traits": { - "smithy.api#documentation": "The app block builder errors.
" - } - }, - "StateChangeReason": { - "target": "com.amazonaws.appstream#AppBlockBuilderStateChangeReason", - "traits": { - "smithy.api#documentation": "The state change reason.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an app block builder.
" - } - }, - "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociation": { - "type": "structure", - "members": { - "AppBlockArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the app block.
", - "smithy.api#required": {} - } - }, - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an association between an app block builder and app block.
" - } - }, - "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.appstream#AppBlockBuilderAttribute": { - "type": "enum", - "members": { - "IAM_ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_ROLE_ARN" - } - }, - "ACCESS_ENDPOINTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_ENDPOINTS" - } - }, - "VPC_CONFIGURATION_SECURITY_GROUP_IDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VPC_CONFIGURATION_SECURITY_GROUP_IDS" - } - } - } - }, - "com.amazonaws.appstream#AppBlockBuilderAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#AppBlockBuilderAttribute" - } - }, - "com.amazonaws.appstream#AppBlockBuilderList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#AppBlockBuilder" - } - }, - "com.amazonaws.appstream#AppBlockBuilderPlatformType": { - "type": "enum", - "members": { - "WINDOWS_SERVER_2019": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2019" - } - } - } - }, - "com.amazonaws.appstream#AppBlockBuilderState": { - "type": "enum", - "members": { - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.appstream#AppBlockBuilderStateChangeReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.appstream#AppBlockBuilderStateChangeReasonCode", - "traits": { - "smithy.api#documentation": "The state change reason code.
" - } - }, - "Message": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The state change reason message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the reason why the last app block builder state change occurred.
" - } - }, - "com.amazonaws.appstream#AppBlockBuilderStateChangeReasonCode": { - "type": "enum", - "members": { - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - } - } - }, - "com.amazonaws.appstream#AppBlockState": { - "type": "enum", - "members": { - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - } - } - }, - "com.amazonaws.appstream#AppBlocks": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#AppBlock" - } - }, - "com.amazonaws.appstream#AppVisibility": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "ASSOCIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASSOCIATED" - } - } - } - }, - "com.amazonaws.appstream#Application": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The name of the application.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The application name to display.
" - } - }, - "IconURL": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The URL for the application icon. This URL might be time-limited.
" - } - }, - "LaunchPath": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The path to the application executable in the instance.
" - } - }, - "LaunchParameters": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The arguments that are passed to the application at launch.
" - } - }, - "Enabled": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#documentation": "If there is a problem, the application can be disabled after image creation.
" - } - }, - "Metadata": { - "target": "com.amazonaws.appstream#Metadata", - "traits": { - "smithy.api#documentation": "Additional attributes that describe the application.
" - } - }, - "WorkingDirectory": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The working directory for the application.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The description of the application.
" - } - }, - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the application.
" - } - }, - "AppBlockArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The app block ARN of the application.
" - } - }, - "IconS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#documentation": "The S3 location of the application icon.
" - } - }, - "Platforms": { - "target": "com.amazonaws.appstream#Platforms", - "traits": { - "smithy.api#documentation": "The platforms on which the application can run.
" - } - }, - "InstanceFamilies": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The instance families for the application.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the application was created within the app block.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an application in the application catalog.
" - } - }, - "com.amazonaws.appstream#ApplicationAttribute": { - "type": "enum", - "members": { - "LAUNCH_PARAMETERS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAUNCH_PARAMETERS" - } - }, - "WORKING_DIRECTORY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WORKING_DIRECTORY" - } - } - } - }, - "com.amazonaws.appstream#ApplicationAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#ApplicationAttribute" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.appstream#ApplicationFleetAssociation": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet associated with the application.
", - "smithy.api#required": {} - } - }, - "ApplicationArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the application associated with the fleet.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the application fleet association.
" - } - }, - "com.amazonaws.appstream#ApplicationFleetAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#ApplicationFleetAssociation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.appstream#ApplicationSettings": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Enables or disables persistent application settings for users during their streaming sessions.
", - "smithy.api#required": {} - } - }, - "SettingsGroup": { - "target": "com.amazonaws.appstream#SettingsGroup", - "traits": { - "smithy.api#documentation": "The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The persistent application settings for users of a stack.
" - } - }, - "com.amazonaws.appstream#ApplicationSettingsResponse": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#documentation": "Specifies whether persistent application settings are enabled for users during their streaming sessions.
" - } - }, - "SettingsGroup": { - "target": "com.amazonaws.appstream#SettingsGroup", - "traits": { - "smithy.api#documentation": "The path prefix for the S3 bucket where users’ persistent application settings are stored.
" - } - }, - "S3BucketName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region. \n
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the persistent application settings for users of a stack.
" - } - }, - "com.amazonaws.appstream#Applications": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Application" - } - }, - "com.amazonaws.appstream#AppstreamAgentVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.appstream#Arn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws(?:\\-cn|\\-iso\\-b|\\-iso|\\-us\\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$" - } - }, - "com.amazonaws.appstream#ArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Arn" - } - }, - "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockRequest" - }, - "output": { - "target": "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Associates the specified app block builder with the specified app block.
" - } - }, - "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockRequest": { - "type": "structure", - "members": { - "AppBlockArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the app block.
", - "smithy.api#required": {} - } - }, - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockResult": { - "type": "structure", - "members": { - "AppBlockBuilderAppBlockAssociation": { - "target": "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociation", - "traits": { - "smithy.api#documentation": "The list of app block builders associated with app blocks.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#AssociateApplicationFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#AssociateApplicationFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#AssociateApplicationFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
" - } - }, - "com.amazonaws.appstream#AssociateApplicationFleetRequest": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "ApplicationArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the application.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#AssociateApplicationFleetResult": { - "type": "structure", - "members": { - "ApplicationFleetAssociation": { - "target": "com.amazonaws.appstream#ApplicationFleetAssociation", - "traits": { - "smithy.api#documentation": "If fleet name is specified, this returns the list of applications that are associated\n to it. If application ARN is specified, this returns the list of fleets to which it is\n associated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#AssociateApplicationToEntitlement": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#AssociateApplicationToEntitlementRequest" - }, - "output": { - "target": "com.amazonaws.appstream#AssociateApplicationToEntitlementResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#EntitlementNotFoundException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Associates an application to entitle.
" - } - }, - "com.amazonaws.appstream#AssociateApplicationToEntitlementRequest": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "EntitlementName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "ApplicationIdentifier": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the application.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#AssociateApplicationToEntitlementResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#AssociateFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#AssociateFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#AssociateFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#IncompatibleImageException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Associates the specified fleet with the specified stack.
" - } - }, - "com.amazonaws.appstream#AssociateFleetRequest": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#AssociateFleetResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#AuthenticationType": { - "type": "enum", - "members": { - "API": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "API" - } - }, - "SAML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAML" - } - }, - "USERPOOL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USERPOOL" - } - }, - "AWS_AD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_AD" - } - } - } - }, - "com.amazonaws.appstream#AwsAccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\d+$" - } - }, - "com.amazonaws.appstream#AwsAccountIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#AwsAccountId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.appstream#BatchAssociateUserStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#BatchAssociateUserStackRequest" - }, - "output": { - "target": "com.amazonaws.appstream#BatchAssociateUserStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - } - ], - "traits": { - "smithy.api#documentation": "Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
" - } - }, - "com.amazonaws.appstream#BatchAssociateUserStackRequest": { - "type": "structure", - "members": { - "UserStackAssociations": { - "target": "com.amazonaws.appstream#UserStackAssociationList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of UserStackAssociation objects.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#BatchAssociateUserStackResult": { - "type": "structure", - "members": { - "errors": { - "target": "com.amazonaws.appstream#UserStackAssociationErrorList", - "traits": { - "smithy.api#documentation": "The list of UserStackAssociationError objects.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#BatchDisassociateUserStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#BatchDisassociateUserStackRequest" - }, - "output": { - "target": "com.amazonaws.appstream#BatchDisassociateUserStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates the specified users from the specified stacks.
" - } - }, - "com.amazonaws.appstream#BatchDisassociateUserStackRequest": { - "type": "structure", - "members": { - "UserStackAssociations": { - "target": "com.amazonaws.appstream#UserStackAssociationList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The list of UserStackAssociation objects.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#BatchDisassociateUserStackResult": { - "type": "structure", - "members": { - "errors": { - "target": "com.amazonaws.appstream#UserStackAssociationErrorList", - "traits": { - "smithy.api#documentation": "The list of UserStackAssociationError objects.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#Boolean": { - "type": "boolean" - }, - "com.amazonaws.appstream#BooleanObject": { - "type": "boolean" - }, - "com.amazonaws.appstream#CertificateBasedAuthProperties": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.appstream#CertificateBasedAuthStatus", - "traits": { - "smithy.api#documentation": "The status of the certificate-based authentication properties.
" - } - }, - "CertificateAuthorityArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the AWS Certificate Manager Private CA resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" - } - }, - "com.amazonaws.appstream#CertificateBasedAuthStatus": { - "type": "enum", - "members": { - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "ENABLED_NO_DIRECTORY_LOGIN_FALLBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED_NO_DIRECTORY_LOGIN_FALLBACK" - } - } - } - }, - "com.amazonaws.appstream#ComputeCapacity": { - "type": "structure", - "members": { - "DesiredInstances": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The desired number of streaming instances.
" - } - }, - "DesiredSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
\nWhen you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the capacity for a fleet.
" - } - }, - "com.amazonaws.appstream#ComputeCapacityStatus": { - "type": "structure", - "members": { - "Desired": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The desired number of streaming instances.
", - "smithy.api#required": {} - } - }, - "Running": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The total number of simultaneous streaming instances that are running.
" - } - }, - "InUse": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The number of instances in use for streaming.
" - } - }, - "Available": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The number of currently available instances that can be used to stream\n sessions.
" - } - }, - "DesiredUserSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
\nDesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
\nThis only applies to multi-session fleets.
" - } - }, - "AvailableUserSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The number of idle session slots currently available for user sessions.
\nAvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
\nThis only applies to multi-session fleets.
" - } - }, - "ActiveUserSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
" - } - }, - "ActualUserSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The total number of session slots that are available for streaming or are currently streaming.
\nActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
\nThis only applies to multi-session fleets.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the capacity status for a fleet.
" - } - }, - "com.amazonaws.appstream#ConcurrentModificationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "An API error occurred. Wait a few minutes and try again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#CopyImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CopyImageRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CopyImageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#IncompatibleImageException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
" - } - }, - "com.amazonaws.appstream#CopyImageRequest": { - "type": "structure", - "members": { - "SourceImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image to copy.
", - "smithy.api#required": {} - } - }, - "DestinationImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name that the image will have when it is copied to the destination.
", - "smithy.api#required": {} - } - }, - "DestinationRegion": { - "target": "com.amazonaws.appstream#RegionName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
", - "smithy.api#required": {} - } - }, - "DestinationImageDescription": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description that the image will have when it is copied to the destination.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CopyImageResponse": { - "type": "structure", - "members": { - "DestinationImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the destination image.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateAppBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateAppBlockRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateAppBlockResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an app block.
\nApp blocks are an Amazon AppStream 2.0 resource that stores the details about the\n virtual hard disk in an S3 bucket. It also stores the setup script with details about\n how to mount the virtual hard disk. The virtual hard disk includes the application\n binaries and other files necessary to launch your applications. Multiple applications\n can be assigned to a single app block.
\nThis is only supported for Elastic fleets.
" - } - }, - "com.amazonaws.appstream#CreateAppBlockBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateAppBlockBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateAppBlockBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.appstream#AccessEndpoint": { + "type": "structure", + "members": { + "EndpointType": { + "target": "com.amazonaws.appstream#AccessEndpointType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of interface endpoint.
", + "smithy.api#required": {} + } + }, + "VpceId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The identifier (ID) of the VPC in which the interface endpoint is used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.
" + } }, - { - "target": "com.amazonaws.appstream#LimitExceededException" + "com.amazonaws.appstream#AccessEndpointList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#AccessEndpoint" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" + "com.amazonaws.appstream#AccessEndpointType": { + "type": "enum", + "members": { + "STREAMING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING" + } + } + } }, - { - "target": "com.amazonaws.appstream#RequestLimitExceededException" + "com.amazonaws.appstream#AccountName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + "com.amazonaws.appstream#AccountPassword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 127 + }, + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" + "com.amazonaws.appstream#Action": { + "type": "enum", + "members": { + "CLIPBOARD_COPY_FROM_LOCAL_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIPBOARD_COPY_FROM_LOCAL_DEVICE" + } + }, + "CLIPBOARD_COPY_TO_LOCAL_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIPBOARD_COPY_TO_LOCAL_DEVICE" + } + }, + "FILE_UPLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_UPLOAD" + } + }, + "FILE_DOWNLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_DOWNLOAD" + } + }, + "PRINTING_TO_LOCAL_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRINTING_TO_LOCAL_DEVICE" + } + }, + "DOMAIN_PASSWORD_SIGNIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_PASSWORD_SIGNIN" + } + }, + "DOMAIN_SMART_CARD_SIGNIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_SMART_CARD_SIGNIN" + } + } + } }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an app block builder.
" - } - }, - "com.amazonaws.appstream#CreateAppBlockBuilderRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The unique name for the app block builder.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the app block builder.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The display name of the app block builder.
" - } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "The tags to associate with the app block builder. A tag is a key-value pair, and the\n value is optional. For example, Environment=Test. If you do not specify a value,\n Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nFor more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "Platform": { - "target": "com.amazonaws.appstream#AppBlockBuilderPlatformType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The platform of the app block builder.
\n\n WINDOWS_SERVER_2019 is the only valid value.
The instance type to use when launching the app block builder. The following instance\n types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe VPC configuration for the app block builder.
\nApp block builders require that you specify at least two subnets in different availability\n zones.
", - "smithy.api#required": {} - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Enables or disables default internet access for the app block builder.
" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To\n assume a role, the app block builder calls the AWS Security Token Service (STS)\n AssumeRole API operation and passes the ARN of the role to use. The\n operation creates a new session with temporary credentials. AppStream 2.0 retrieves the\n temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateAppBlockBuilderResult": { - "type": "structure", - "members": { - "AppBlockBuilder": { - "target": "com.amazonaws.appstream#AppBlockBuilder" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURL": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a URL to start a create app block builder streaming session.
" - } - }, - "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLRequest": { - "type": "structure", - "members": { - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - }, - "Validity": { - "target": "com.amazonaws.appstream#Long", - "traits": { - "smithy.api#documentation": "The time that the streaming URL will be valid, in seconds. \n Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLResult": { - "type": "structure", - "members": { - "StreamingURL": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The URL to start the streaming session.
" - } - }, - "Expires": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The elapsed time, in seconds after the Unix epoch, when this URL expires.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateAppBlockRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the app block.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The display name of the app block. This is not displayed to the user.
" - } - }, - "SourceS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The source S3 location of the app block.
", - "smithy.api#required": {} - } - }, - "SetupScriptDetails": { - "target": "com.amazonaws.appstream#ScriptDetails", - "traits": { - "smithy.api#documentation": "The setup script details of the app block. This must be provided for the\n CUSTOM PackagingType.
The tags assigned to the app block.
" - } - }, - "PostSetupScriptDetails": { - "target": "com.amazonaws.appstream#ScriptDetails", - "traits": { - "smithy.api#documentation": "The post setup script details of the app block. This can only be provided for the\n APPSTREAM2 PackagingType.
The packaging type of the app block.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateAppBlockResult": { - "type": "structure", - "members": { - "AppBlock": { - "target": "com.amazonaws.appstream#AppBlock", - "traits": { - "smithy.api#documentation": "The app block.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateApplicationResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an application.
\nApplications are an Amazon AppStream 2.0 resource that stores the details about how to\n launch applications on Elastic fleet streaming instances. An application consists of the\n launch details, icon, and display name. Applications are associated with an app block\n that contains the application binaries and other files. The applications assigned to an\n Elastic fleet are the applications users can launch.
\nThis is only supported for Elastic fleets.
" - } - }, - "com.amazonaws.appstream#CreateApplicationRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the application. This name is visible to users when display name is not specified.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The display name of the application. This name is visible to users in the application catalog.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the application.
" - } - }, - "IconS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The location in S3 of the application icon.
", - "smithy.api#required": {} - } - }, - "LaunchPath": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The launch path of the application.
", - "smithy.api#required": {} - } - }, - "WorkingDirectory": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The working directory of the application.
" - } - }, - "LaunchParameters": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The launch parameters of the application.
" - } - }, - "Platforms": { - "target": "com.amazonaws.appstream#Platforms", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
", - "smithy.api#required": {} - } - }, - "InstanceFamilies": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
", - "smithy.api#required": {} - } - }, - "AppBlockArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The app block ARN to which the application should be associated
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "The tags assigned to the application.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateApplicationResult": { - "type": "structure", - "members": { - "Application": { - "target": "com.amazonaws.appstream#Application" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateDirectoryConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateDirectoryConfigRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateDirectoryConfigResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" - } - }, - "com.amazonaws.appstream#CreateDirectoryConfigRequest": { - "type": "structure", - "members": { - "DirectoryName": { - "target": "com.amazonaws.appstream#DirectoryName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The fully qualified name of the directory (for example, corp.example.com).
", - "smithy.api#required": {} - } - }, - "OrganizationalUnitDistinguishedNames": { - "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The distinguished names of the organizational units for computer accounts.
", - "smithy.api#required": {} - } - }, - "ServiceAccountCredentials": { - "target": "com.amazonaws.appstream#ServiceAccountCredentials", - "traits": { - "smithy.api#documentation": "The credentials for the service account used by the fleet or image builder to connect to the directory.
" - } - }, - "CertificateBasedAuthProperties": { - "target": "com.amazonaws.appstream#CertificateBasedAuthProperties", - "traits": { - "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateDirectoryConfigResult": { - "type": "structure", - "members": { - "DirectoryConfig": { - "target": "com.amazonaws.appstream#DirectoryConfig", - "traits": { - "smithy.api#documentation": "Information about the directory configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "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#clientOptional": {}, - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "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#clientOptional": {}, - "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.appstream#EntitlementAttributeList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The attributes of the entitlement.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateEntitlementResult": { - "type": "structure", - "members": { - "Entitlement": { - "target": "com.amazonaws.appstream#Entitlement", - "traits": { - "smithy.api#documentation": "The entitlement.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" + "com.amazonaws.appstream#AppBlock": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description of the app block.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The display name of the app block.
" + } + }, + "SourceS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The source S3 location of the app block.
" + } + }, + "SetupScriptDetails": { + "target": "com.amazonaws.appstream#ScriptDetails", + "traits": { + "smithy.api#documentation": "The setup script details of the app block.
\nThis only applies to app blocks with PackagingType CUSTOM.
The created time of the app block.
" + } + }, + "PostSetupScriptDetails": { + "target": "com.amazonaws.appstream#ScriptDetails", + "traits": { + "smithy.api#documentation": "The post setup script details of the app block.
\nThis only applies to app blocks with PackagingType APPSTREAM2.
The packaging type of the app block.
" + } + }, + "State": { + "target": "com.amazonaws.appstream#AppBlockState", + "traits": { + "smithy.api#documentation": "The state of the app block.
\nAn app block with AppStream 2.0 packaging will be in the INACTIVE state\n if no application package (VHD) is assigned to it. After an application package (VHD) is\n created by an app block builder for an app block, it becomes ACTIVE.
Custom app blocks are always in the ACTIVE state and no action is required to use them.
The errors of the app block.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an app block.
\nApp blocks are an Amazon AppStream 2.0 resource that stores the details about the\n virtual hard disk in an S3 bucket. It also stores the setup script with details about\n how to mount the virtual hard disk. The virtual hard disk includes the application\n binaries and other files necessary to launch your applications. Multiple applications\n can be assigned to a single app block.
\nThis is only supported for Elastic fleets.
" + } }, - { - "target": "com.amazonaws.appstream#IncompatibleImageException" + "com.amazonaws.appstream#AppBlockBuilder": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the app block builder.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The display name of the app block builder.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description of the app block builder.
" + } + }, + "Platform": { + "target": "com.amazonaws.appstream#AppBlockBuilderPlatformType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The platform of the app block builder.
\n\n WINDOWS_SERVER_2019 is the only valid value.
The instance type of the app block builder.
", + "smithy.api#required": {} + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Indicates whether default internet access is enabled for the app block builder.
" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that is applied to the app block builder.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The VPC configuration for the app block builder.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.appstream#AppBlockBuilderState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The state of the app block builder.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The creation time of the app block builder.
" + } + }, + "AppBlockBuilderErrors": { + "target": "com.amazonaws.appstream#ResourceErrors", + "traits": { + "smithy.api#documentation": "The app block builder errors.
" + } + }, + "StateChangeReason": { + "target": "com.amazonaws.appstream#AppBlockBuilderStateChangeReason", + "traits": { + "smithy.api#documentation": "The state change reason.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an app block builder.
" + } }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" + "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociation": { + "type": "structure", + "members": { + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an association between an app block builder and app block.
" + } }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" + "com.amazonaws.appstream#AppBlockBuilderAttribute": { + "type": "enum", + "members": { + "IAM_ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE_ARN" + } + }, + "ACCESS_ENDPOINTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_ENDPOINTS" + } + }, + "VPC_CONFIGURATION_SECURITY_GROUP_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_CONFIGURATION_SECURITY_GROUP_IDS" + } + } + } }, - { - "target": "com.amazonaws.appstream#LimitExceededException" + "com.amazonaws.appstream#AppBlockBuilderAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#AppBlockBuilderAttribute" + } }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" + "com.amazonaws.appstream#AppBlockBuilderList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#AppBlockBuilder" + } }, - { - "target": "com.amazonaws.appstream#RequestLimitExceededException" + "com.amazonaws.appstream#AppBlockBuilderPlatformType": { + "type": "enum", + "members": { + "WINDOWS_SERVER_2019": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2019" + } + } + } }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + "com.amazonaws.appstream#AppBlockBuilderState": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" + "com.amazonaws.appstream#AppBlockBuilderStateChangeReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.appstream#AppBlockBuilderStateChangeReasonCode", + "traits": { + "smithy.api#documentation": "The state change reason code.
" + } + }, + "Message": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The state change reason message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the reason why the last app block builder state change occurred.
" + } }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
" - } - }, - "com.amazonaws.appstream#CreateFleetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A unique name for the fleet.
", - "smithy.api#required": {} - } - }, - "ImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the image used to create the fleet.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the public, private, or shared image to use.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe following instance types are available for Elastic fleets:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe fleet type.
\nProvides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.
\nProvide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.
\nThe desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", - "traits": { - "smithy.api#documentation": "The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
" - } - }, - "MaxUserDurationInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
\nSpecify a value between 600 and 432000.
" - } - }, - "DisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
\nSpecify a value between 60 and 360000.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The fleet name to display.
" - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Enables or disables default internet access for the fleet.
" - } - }, - "DomainJoinInfo": { - "target": "com.amazonaws.appstream#DomainJoinInfo", - "traits": { - "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
" - } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nFor more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "IdleDisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n they try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "StreamView": { - "target": "com.amazonaws.appstream#StreamView", - "traits": { - "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic\n fleets.
" - } - }, - "MaxConcurrentSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum concurrent sessions of the Elastic fleet. This is required for Elastic\n fleets, and not allowed for other fleet types.
" - } - }, - "UsbDeviceFilterStrings": { - "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", - "traits": { - "smithy.api#documentation": "The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
" - } - }, - "SessionScriptS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#documentation": "The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
" - } - }, - "MaxSessionsPerInstance": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateFleetResult": { - "type": "structure", - "members": { - "Fleet": { - "target": "com.amazonaws.appstream#Fleet", - "traits": { - "smithy.api#documentation": "Information about the fleet.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateImageBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateImageBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateImageBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" + "com.amazonaws.appstream#AppBlockBuilderStateChangeReasonCode": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + } + } }, - { - "target": "com.amazonaws.appstream#IncompatibleImageException" + "com.amazonaws.appstream#AppBlockState": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" + "com.amazonaws.appstream#AppBlocks": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#AppBlock" + } }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + "com.amazonaws.appstream#AppVisibility": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "ASSOCIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED" + } + } + } }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" + "com.amazonaws.appstream#Application": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the application.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The application name to display.
" + } + }, + "IconURL": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The URL for the application icon. This URL might be time-limited.
" + } + }, + "LaunchPath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The path to the application executable in the instance.
" + } + }, + "LaunchParameters": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The arguments that are passed to the application at launch.
" + } + }, + "Enabled": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#documentation": "If there is a problem, the application can be disabled after image creation.
" + } + }, + "Metadata": { + "target": "com.amazonaws.appstream#Metadata", + "traits": { + "smithy.api#documentation": "Additional attributes that describe the application.
" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The working directory for the application.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
" + } + }, + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The app block ARN of the application.
" + } + }, + "IconS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The S3 location of the application icon.
" + } + }, + "Platforms": { + "target": "com.amazonaws.appstream#Platforms", + "traits": { + "smithy.api#documentation": "The platforms on which the application can run.
" + } + }, + "InstanceFamilies": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The instance families for the application.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the application was created within the app block.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an application in the application catalog.
" + } }, - { - "target": "com.amazonaws.appstream#LimitExceededException" + "com.amazonaws.appstream#ApplicationAttribute": { + "type": "enum", + "members": { + "LAUNCH_PARAMETERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAUNCH_PARAMETERS" + } + }, + "WORKING_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKING_DIRECTORY" + } + } + } }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" + "com.amazonaws.appstream#ApplicationAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#ApplicationAttribute" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } }, - { - "target": "com.amazonaws.appstream#RequestLimitExceededException" + "com.amazonaws.appstream#ApplicationFleetAssociation": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet associated with the application.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the application associated with the fleet.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the application fleet association.
" + } }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + "com.amazonaws.appstream#ApplicationFleetAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#ApplicationFleetAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" + "com.amazonaws.appstream#ApplicationSettings": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Enables or disables persistent application settings for users during their streaming sessions.
", + "smithy.api#required": {} + } + }, + "SettingsGroup": { + "target": "com.amazonaws.appstream#SettingsGroup", + "traits": { + "smithy.api#documentation": "The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The persistent application settings for users of a stack.
" + } }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an image builder. An image builder is a virtual machine that is used to create an image.
\nThe initial state of the builder is PENDING. When it is ready, the state is RUNNING.
A unique name for the image builder.
", - "smithy.api#required": {} - } - }, - "ImageName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The name of the image used to create the image builder.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the public, private, or shared image to use.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance type to use when launching the image builder. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe description to display.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The image builder name to display.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", - "traits": { - "smithy.api#documentation": "The VPC configuration for the image builder. You can specify only one subnet.
" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Enables or disables default internet access for the image builder.
" - } - }, - "DomainJoinInfo": { - "target": "com.amazonaws.appstream#DomainJoinInfo", - "traits": { - "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
" - } - }, - "AppstreamAgentVersion": { - "target": "com.amazonaws.appstream#AppstreamAgentVersion", - "traits": { - "smithy.api#documentation": "The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
" - } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nIf you do not specify a value, the value is set to an empty string.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateImageBuilderResult": { - "type": "structure", - "members": { - "ImageBuilder": { - "target": "com.amazonaws.appstream#ImageBuilder", - "traits": { - "smithy.api#documentation": "Information about the image builder.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateImageBuilderStreamingURL": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateImageBuilderStreamingURLRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateImageBuilderStreamingURLResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a URL to start an image builder streaming session.
" - } - }, - "com.amazonaws.appstream#CreateImageBuilderStreamingURLRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image builder.
", - "smithy.api#required": {} - } - }, - "Validity": { - "target": "com.amazonaws.appstream#Long", - "traits": { - "smithy.api#documentation": "The time that the streaming URL will be valid, in seconds. \n Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateImageBuilderStreamingURLResult": { - "type": "structure", - "members": { - "StreamingURL": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The URL to start the AppStream 2.0 streaming session.
" - } - }, - "Expires": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The elapsed time, in seconds after the Unix epoch, when this URL expires.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateStackRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
" - } - }, - "com.amazonaws.appstream#CreateStackRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The stack name to display.
" - } - }, - "StorageConnectors": { - "target": "com.amazonaws.appstream#StorageConnectorList", - "traits": { - "smithy.api#documentation": "The storage connectors to enable.
" - } - }, - "RedirectURL": { - "target": "com.amazonaws.appstream#RedirectURL", - "traits": { - "smithy.api#documentation": "The URL that users are redirected to after their streaming session ends.
" - } - }, - "FeedbackURL": { - "target": "com.amazonaws.appstream#FeedbackURL", - "traits": { - "smithy.api#documentation": "The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
" - } - }, - "UserSettings": { - "target": "com.amazonaws.appstream#UserSettingList", - "traits": { - "smithy.api#documentation": "The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
" - } - }, - "ApplicationSettings": { - "target": "com.amazonaws.appstream#ApplicationSettings", - "traits": { - "smithy.api#documentation": "The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
" - } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
" - } - }, - "EmbedHostDomains": { - "target": "com.amazonaws.appstream#EmbedHostDomains", - "traits": { - "smithy.api#documentation": "The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
" - } - }, - "StreamingExperienceSettings": { - "target": "com.amazonaws.appstream#StreamingExperienceSettings", - "traits": { - "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateStackResult": { - "type": "structure", - "members": { - "Stack": { - "target": "com.amazonaws.appstream#Stack", - "traits": { - "smithy.api#documentation": "Information about the stack.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateStreamingURL": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateStreamingURLRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateStreamingURLResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
" - } - }, - "com.amazonaws.appstream#CreateStreamingURLRequest": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.appstream#StreamingUrlUserId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the user.
", - "smithy.api#required": {} - } - }, - "ApplicationId": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The name of the application to launch after the session starts. This is the name that you specified\n as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.
" - } - }, - "Validity": { - "target": "com.amazonaws.appstream#Long", - "traits": { - "smithy.api#documentation": "The time that the streaming URL will be valid, in seconds.\n Specify a value between 1 and 604800 seconds. The default is 60 seconds.
" - } - }, - "SessionContext": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateStreamingURLResult": { - "type": "structure", - "members": { - "StreamingURL": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The URL to start the AppStream 2.0 streaming session.
" - } - }, - "Expires": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The elapsed time, in seconds after the Unix epoch, when this URL expires.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateUpdatedImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateUpdatedImageRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateUpdatedImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#IncompatibleImageException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
\nFor more information, see the \"Update an Image by Using\n Managed AppStream 2.0 Image Updates\" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "com.amazonaws.appstream#CreateUpdatedImageRequest": { - "type": "structure", - "members": { - "existingImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image to update.
", - "smithy.api#required": {} - } - }, - "newImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the new image. The name must be unique within the AWS account and Region.
", - "smithy.api#required": {} - } - }, - "newImageDescription": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description to display for the new image.
" - } - }, - "newImageDisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The name to display for the new image.
" - } - }, - "newImageTags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nIf you do not specify a value, the value is set to an empty string.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "dryRun": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.
Indicates whether a new image can be created.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateUsageReportSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateUsageReportSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateUsageReportSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a usage report subscription. Usage reports are generated daily.
" - } - }, - "com.amazonaws.appstream#CreateUsageReportSubscriptionRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateUsageReportSubscriptionResult": { - "type": "structure", - "members": { - "S3BucketName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The Amazon S3 bucket where generated reports are stored.
\nIf you enabled on-instance session scripts and Amazon S3 logging for your session script\n configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is\n unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0\n uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, \n when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
" - } - }, - "Schedule": { - "target": "com.amazonaws.appstream#UsageReportSchedule", - "traits": { - "smithy.api#documentation": "The schedule for generating usage reports.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#CreateUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#CreateUserRequest" - }, - "output": { - "target": "com.amazonaws.appstream#CreateUserResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new user in the user pool.
" - } - }, - "com.amazonaws.appstream#CreateUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.
\nThe action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
\nThe temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
\nThe first name, or given name, of the user.
" - } - }, - "LastName": { - "target": "com.amazonaws.appstream#UserAttributeValue", - "traits": { - "smithy.api#documentation": "The last name, or surname, of the user.
" - } - }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The authentication type for the user. You must specify USERPOOL.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#CreateUserResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteAppBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteAppBlockRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteAppBlockResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an app block.
" - } - }, - "com.amazonaws.appstream#DeleteAppBlockBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteAppBlockBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteAppBlockBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an app block builder.
\nAn app block builder can only be deleted when it has no association with an app\n block.
" - } - }, - "com.amazonaws.appstream#DeleteAppBlockBuilderRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteAppBlockBuilderResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteAppBlockRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteAppBlockResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteApplicationRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteApplicationResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an application.
" - } - }, - "com.amazonaws.appstream#DeleteApplicationRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the application.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteApplicationResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteDirectoryConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteDirectoryConfigRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteDirectoryConfigResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
" - } - }, - "com.amazonaws.appstream#DeleteDirectoryConfigRequest": { - "type": "structure", - "members": { - "DirectoryName": { - "target": "com.amazonaws.appstream#DirectoryName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the directory configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteDirectoryConfigResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "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#clientOptional": {}, - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteEntitlementResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified fleet.
" - } - }, - "com.amazonaws.appstream#DeleteFleetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteFleetResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteImage": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteImageRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteImageResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified image. You cannot delete an image when it is in use. \n After you delete an image, you cannot provision new capacity using the image.
" - } - }, - "com.amazonaws.appstream#DeleteImageBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteImageBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteImageBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified image builder and releases the capacity.
" - } - }, - "com.amazonaws.appstream#DeleteImageBuilderRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteImageBuilderResult": { - "type": "structure", - "members": { - "ImageBuilder": { - "target": "com.amazonaws.appstream#ImageBuilder", - "traits": { - "smithy.api#documentation": "Information about the image builder.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteImagePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteImagePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteImagePermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
" - } - }, - "com.amazonaws.appstream#DeleteImagePermissionsRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the private image.
", - "smithy.api#required": {} - } - }, - "SharedAccountId": { - "target": "com.amazonaws.appstream#AwsAccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The 12-digit identifier of the AWS account for which to delete image permissions.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteImagePermissionsResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteImageRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteImageResult": { - "type": "structure", - "members": { - "Image": { - "target": "com.amazonaws.appstream#Image", - "traits": { - "smithy.api#documentation": "Information about the image.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteStackRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
" - } - }, - "com.amazonaws.appstream#DeleteStackRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteStackResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteUsageReportSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteUsageReportSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteUsageReportSubscriptionResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Disables usage report generation.
" - } - }, - "com.amazonaws.appstream#DeleteUsageReportSubscriptionRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteUsageReportSubscriptionResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DeleteUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DeleteUserRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DeleteUserResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a user from the user pool.
" - } - }, - "com.amazonaws.appstream#DeleteUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user. You must specify USERPOOL.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DeleteUserResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more app block builder associations.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsRequest": { - "type": "structure", - "members": { - "AppBlockArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the app block.
" - } - }, - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the app block builder.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsResult": { - "type": "structure", - "members": { - "AppBlockBuilderAppBlockAssociations": { - "target": "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociationsList", - "traits": { - "smithy.api#documentation": "This list of app block builders associated with app blocks.
" - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeAppBlockBuilders": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeAppBlockBuildersRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeAppBlockBuildersResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more app block builders.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.appstream#DescribeAppBlockBuildersRequest": { - "type": "structure", - "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The names of the app block builders.
" - } - }, - "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.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results. The maximum value is 25.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeAppBlockBuildersResult": { - "type": "structure", - "members": { - "AppBlockBuilders": { - "target": "com.amazonaws.appstream#AppBlockBuilderList", - "traits": { - "smithy.api#documentation": "The list that describes one or more app block builders.
" - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeAppBlocks": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeAppBlocksRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeAppBlocksResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more app blocks.
" - } - }, - "com.amazonaws.appstream#DescribeAppBlocksRequest": { - "type": "structure", - "members": { - "Arns": { - "target": "com.amazonaws.appstream#ArnList", - "traits": { - "smithy.api#documentation": "The ARNs of the app blocks.
" - } - }, - "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.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeAppBlocksResult": { - "type": "structure", - "members": { - "AppBlocks": { - "target": "com.amazonaws.appstream#AppBlocks", - "traits": { - "smithy.api#documentation": "The app blocks in the list.
" - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeApplicationFleetAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
" - } - }, - "com.amazonaws.appstream#DescribeApplicationFleetAssociationsRequest": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the fleet.
" - } - }, - "ApplicationArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the application.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeApplicationFleetAssociationsResult": { - "type": "structure", - "members": { - "ApplicationFleetAssociations": { - "target": "com.amazonaws.appstream#ApplicationFleetAssociationList", - "traits": { - "smithy.api#documentation": "The application fleet associations in the list.
" - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeApplications": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeApplicationsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeApplicationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more applications.
" - } - }, - "com.amazonaws.appstream#DescribeApplicationsRequest": { - "type": "structure", - "members": { - "Arns": { - "target": "com.amazonaws.appstream#ArnList", - "traits": { - "smithy.api#documentation": "The ARNs for the applications.
" - } - }, - "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.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeApplicationsResult": { - "type": "structure", - "members": { - "Applications": { - "target": "com.amazonaws.appstream#Applications", - "traits": { - "smithy.api#documentation": "The applications in the list.
" - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeDirectoryConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeDirectoryConfigsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeDirectoryConfigsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. \n
\nAlthough the response syntax in this topic includes the account password, this password is not returned in the actual response.
" - } - }, - "com.amazonaws.appstream#DescribeDirectoryConfigsRequest": { - "type": "structure", - "members": { - "DirectoryNames": { - "target": "com.amazonaws.appstream#DirectoryNameList", - "traits": { - "smithy.api#documentation": "The directory names.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeDirectoryConfigsResult": { - "type": "structure", - "members": { - "DirectoryConfigs": { - "target": "com.amazonaws.appstream#DirectoryConfigList", - "traits": { - "smithy.api#documentation": "Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "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#clientOptional": {}, - "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.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeFleetsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeFleetsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
", - "smithy.waiters#waitable": { - "FleetStarted": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Fleets[].State", - "expected": "RUNNING", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Fleets[].State", - "expected": "STOPPING", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Fleets[].State", - "expected": "STOPPED", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - }, - "FleetStopped": { - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Fleets[].State", - "expected": "STOPPED", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Fleets[].State", - "expected": "STARTING", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Fleets[].State", - "expected": "RUNNING", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.appstream#DescribeFleetsRequest": { - "type": "structure", - "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The names of the fleets to describe.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeFleetsResult": { - "type": "structure", - "members": { - "Fleets": { - "target": "com.amazonaws.appstream#FleetList", - "traits": { - "smithy.api#documentation": "Information about the fleets.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeImageBuilders": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeImageBuildersRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeImageBuildersResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
" - } - }, - "com.amazonaws.appstream#DescribeImageBuildersRequest": { - "type": "structure", - "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The names of the image builders to describe.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeImageBuildersResult": { - "type": "structure", - "members": { - "ImageBuilders": { - "target": "com.amazonaws.appstream#ImageBuilderList", - "traits": { - "smithy.api#documentation": "Information about the image builders.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeImagePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeImagePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeImagePermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.appstream#DescribeImagePermissionsRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the private image for which to describe permissions. The image must be one that you own.
", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "SharedAwsAccountIds": { - "target": "com.amazonaws.appstream#AwsAccountIdList", - "traits": { - "smithy.api#documentation": "The 12-digit identifier of one or more AWS accounts with which the image is shared.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeImagePermissionsResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the private image.
" - } - }, - "SharedImagePermissionsList": { - "target": "com.amazonaws.appstream#SharedImagePermissionsList", - "traits": { - "smithy.api#documentation": "The permissions for a private image that you own.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeImages": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeImagesRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeImagesResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.appstream#DescribeImagesMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.appstream#DescribeImagesRequest": { - "type": "structure", - "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The names of the public or private images to describe.
" - } - }, - "Arns": { - "target": "com.amazonaws.appstream#ArnList", - "traits": { - "smithy.api#documentation": "The ARNs of the public, private, and shared images to describe.
" - } - }, - "Type": { - "target": "com.amazonaws.appstream#VisibilityType", - "traits": { - "smithy.api#documentation": "The type of image (public, private, or shared) to describe.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#DescribeImagesMaxResults", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeImagesResult": { - "type": "structure", - "members": { - "Images": { - "target": "com.amazonaws.appstream#ImageList", - "traits": { - "smithy.api#documentation": "Information about the images.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeSessions": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeSessionsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeSessionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet,\n only streaming sessions for that user are described. If an authentication type is not provided, \n the default is to authenticate users using a streaming URL.
" - } - }, - "com.amazonaws.appstream#DescribeSessionsRequest": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack. This value is case-sensitive.
", - "smithy.api#required": {} - } - }, - "FleetName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet. This value is case-sensitive.
", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.appstream#UserId", - "traits": { - "smithy.api#documentation": "The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - }, - "Limit": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The size of each page of results. The default value is 20 and the maximum value is 50.
" - } - }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", - "traits": { - "smithy.api#documentation": "The authentication method. Specify API for a user\n authenticated using a streaming URL or SAML for a SAML federated user. \n The default is to authenticate users using a streaming URL.
The identifier for the instance hosting the session.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeSessionsResult": { - "type": "structure", - "members": { - "Sessions": { - "target": "com.amazonaws.appstream#SessionList", - "traits": { - "smithy.api#documentation": "Information about the streaming sessions.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeStacks": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeStacksRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeStacksResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
" - } - }, - "com.amazonaws.appstream#DescribeStacksRequest": { - "type": "structure", - "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The names of the stacks to describe.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeStacksResult": { - "type": "structure", - "members": { - "Stacks": { - "target": "com.amazonaws.appstream#StackList", - "traits": { - "smithy.api#documentation": "Information about the stacks.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeUsageReportSubscriptions": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeUsageReportSubscriptionsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeUsageReportSubscriptionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more usage report subscriptions.
" - } - }, - "com.amazonaws.appstream#DescribeUsageReportSubscriptionsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeUsageReportSubscriptionsResult": { - "type": "structure", - "members": { - "UsageReportSubscriptions": { - "target": "com.amazonaws.appstream#UsageReportSubscriptionList", - "traits": { - "smithy.api#documentation": "Information about the usage report subscription.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeUserStackAssociations": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeUserStackAssociationsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeUserStackAssociationsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
\nThe stack name
\nThe user name (email address of the user associated with the stack) and the authentication type for the user
\nThe name of the stack that is associated with the user.
" - } - }, - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#documentation": "The email address of the user who is associated with the stack.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user who is associated with the stack. You must specify USERPOOL.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeUserStackAssociationsResult": { - "type": "structure", - "members": { - "UserStackAssociations": { - "target": "com.amazonaws.appstream#UserStackAssociationList", - "traits": { - "smithy.api#documentation": "The UserStackAssociation objects.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DescribeUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DescribeUsersRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DescribeUsersResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list that describes one or more specified users in the user pool.
" - } - }, - "com.amazonaws.appstream#DescribeUsersRequest": { - "type": "structure", - "members": { - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The authentication type for the users in the user pool to describe. You must specify USERPOOL.
", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DescribeUsersResult": { - "type": "structure", - "members": { - "Users": { - "target": "com.amazonaws.appstream#UserList", - "traits": { - "smithy.api#documentation": "Information about users in the user pool.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.appstream#DirectoryConfig": { - "type": "structure", - "members": { - "DirectoryName": { - "target": "com.amazonaws.appstream#DirectoryName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The fully qualified name of the directory (for example, corp.example.com).
", - "smithy.api#required": {} - } - }, - "OrganizationalUnitDistinguishedNames": { - "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", - "traits": { - "smithy.api#documentation": "The distinguished names of the organizational units for computer accounts.
" - } - }, - "ServiceAccountCredentials": { - "target": "com.amazonaws.appstream#ServiceAccountCredentials", - "traits": { - "smithy.api#documentation": "The credentials for the service account used by the fleet or image builder to connect to the directory.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time the directory configuration was created.
" - } - }, - "CertificateBasedAuthProperties": { - "target": "com.amazonaws.appstream#CertificateBasedAuthProperties", - "traits": { - "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" - } - }, - "com.amazonaws.appstream#DirectoryConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#DirectoryConfig" - } - }, - "com.amazonaws.appstream#DirectoryName": { - "type": "string" - }, - "com.amazonaws.appstream#DirectoryNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#DirectoryName" - } - }, - "com.amazonaws.appstream#DisableUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DisableUserRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DisableUserResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
" - } - }, - "com.amazonaws.appstream#DisableUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user. You must specify USERPOOL.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DisableUserResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlock": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates a specified app block builder from a specified app block.
" - } - }, - "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockRequest": { - "type": "structure", - "members": { - "AppBlockArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the app block.
", - "smithy.api#required": {} - } - }, - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DisassociateApplicationFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DisassociateApplicationFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DisassociateApplicationFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates the specified application from the fleet.
" - } - }, - "com.amazonaws.appstream#DisassociateApplicationFleetRequest": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "ApplicationArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the application.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DisassociateApplicationFleetResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "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#clientOptional": {}, - "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#clientOptional": {}, - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "ApplicationIdentifier": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the application to remove from the entitlement.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DisassociateApplicationFromEntitlementResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DisassociateFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#DisassociateFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#DisassociateFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates the specified fleet from the specified stack.
" - } - }, - "com.amazonaws.appstream#DisassociateFleetRequest": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#DisassociateFleetResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#DisplayName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.appstream#Domain": { - "type": "string", - "traits": { - "smithy.api#documentation": "GSuite domain for GDrive integration.", - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.appstream#DomainJoinInfo": { - "type": "structure", - "members": { - "DirectoryName": { - "target": "com.amazonaws.appstream#DirectoryName", - "traits": { - "smithy.api#documentation": "The fully qualified name of the directory (for example, corp.example.com).
" - } - }, - "OrganizationalUnitDistinguishedName": { - "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedName", - "traits": { - "smithy.api#documentation": "The distinguished name of the organizational unit for computer accounts.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" - } - }, - "com.amazonaws.appstream#DomainList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Domain" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.appstream#EmbedHostDomain": { - "type": "string", - "traits": { - "smithy.api#documentation": "Specifies a valid domain that can embed AppStream.\n Valid examples include: [\"testorigin.tt--com\", \"testingorigin.com.us\", \"test.com.us\"]\n Invalid examples include: [\"test,com\", \".com\", \"h*llo.com\". \"\"]", - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" - } - }, - "com.amazonaws.appstream#EmbedHostDomains": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#EmbedHostDomain" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.appstream#EnableUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#EnableUserRequest" - }, - "output": { - "target": "com.amazonaws.appstream#EnableUserResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
" - } - }, - "com.amazonaws.appstream#EnableUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.
\nThe authentication type for the user. You must specify USERPOOL.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#EnableUserResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#EntitledApplication": { - "type": "structure", - "members": { - "ApplicationIdentifier": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "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#clientOptional": {}, - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "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#clientOptional": {}, - "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.appstream#EntitlementAttributeList", - "traits": { - "smithy.api#clientOptional": {}, - "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#clientOptional": {}, - "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#clientOptional": {}, - "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#ErrorDetails": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The error code.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The error message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The error details.
" - } - }, - "com.amazonaws.appstream#ErrorDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#ErrorDetails" - } - }, - "com.amazonaws.appstream#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#documentation": "The error message in the exception.
" - } - }, - "com.amazonaws.appstream#ExpireSession": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#ExpireSessionRequest" - }, - "output": { - "target": "com.amazonaws.appstream#ExpireSessionResult" - }, - "traits": { - "smithy.api#documentation": "Immediately stops the specified streaming session.
" - } - }, - "com.amazonaws.appstream#ExpireSessionRequest": { - "type": "structure", - "members": { - "SessionId": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the streaming session.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#ExpireSessionResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#FeedbackURL": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.appstream#Fleet": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the fleet.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The fleet name to display.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "ImageName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The name of the image used to create the fleet.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN for the public, private, or shared image.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe fleet type.
\nProvides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.
\nProvide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.
\nThe capacity status for the fleet.
", - "smithy.api#required": {} - } - }, - "MaxUserDurationInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
\nSpecify a value between 600 and 360000.
" - } - }, - "DisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
\nSpecify a value between 60 and 360000.
" - } - }, - "State": { - "target": "com.amazonaws.appstream#FleetState", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current state for the fleet.
", - "smithy.api#required": {} - } - }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", - "traits": { - "smithy.api#documentation": "The VPC configuration for the fleet.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time the fleet was created.
" - } - }, - "FleetErrors": { - "target": "com.amazonaws.appstream#FleetErrors", - "traits": { - "smithy.api#documentation": "The fleet errors.
" - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Indicates whether default internet access is enabled for the fleet.
" - } - }, - "DomainJoinInfo": { - "target": "com.amazonaws.appstream#DomainJoinInfo", - "traits": { - "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
" - } - }, - "IdleDisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "StreamView": { - "target": "com.amazonaws.appstream#StreamView", - "traits": { - "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The platform of the fleet.
" - } - }, - "MaxConcurrentSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of concurrent sessions for the fleet.
" - } - }, - "UsbDeviceFilterStrings": { - "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", - "traits": { - "smithy.api#documentation": "The USB device filter strings associated with the fleet.
" - } - }, - "SessionScriptS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#documentation": "The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
" - } - }, - "MaxSessionsPerInstance": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a fleet.
" - } - }, - "com.amazonaws.appstream#FleetAttribute": { - "type": "enum", - "members": { - "VPC_CONFIGURATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VPC_CONFIGURATION" - } - }, - "VPC_CONFIGURATION_SECURITY_GROUP_IDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VPC_CONFIGURATION_SECURITY_GROUP_IDS" - } - }, - "DOMAIN_JOIN_INFO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_INFO" - } - }, - "IAM_ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_ROLE_ARN" - } - }, - "USB_DEVICE_FILTER_STRINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USB_DEVICE_FILTER_STRINGS" - } - }, - "SESSION_SCRIPT_S3_LOCATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SESSION_SCRIPT_S3_LOCATION" - } - }, - "MAX_SESSIONS_PER_INSTANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_SESSIONS_PER_INSTANCE" - } - } - }, - "traits": { - "smithy.api#documentation": "The fleet attribute.
" - } - }, - "com.amazonaws.appstream#FleetAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#FleetAttribute" - }, - "traits": { - "smithy.api#documentation": "The fleet attributes.
" - } - }, - "com.amazonaws.appstream#FleetError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.appstream#FleetErrorCode", - "traits": { - "smithy.api#documentation": "The error code.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The error message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a fleet error.
" - } - }, - "com.amazonaws.appstream#FleetErrorCode": { - "type": "enum", - "members": { - "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION" - } - }, - "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION" - } - }, - "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION" - } - }, - "NETWORK_INTERFACE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NETWORK_INTERFACE_LIMIT_EXCEEDED" - } - }, - "INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" - } - }, - "IAM_SERVICE_ROLE_IS_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_SERVICE_ROLE_IS_MISSING" - } - }, - "MACHINE_ROLE_IS_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MACHINE_ROLE_IS_MISSING" - } - }, - "STS_DISABLED_IN_REGION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STS_DISABLED_IN_REGION" - } - }, - "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES" - } - }, - "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION" - } - }, - "SUBNET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUBNET_NOT_FOUND" - } - }, - "IMAGE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE_NOT_FOUND" - } - }, - "INVALID_SUBNET_CONFIGURATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_SUBNET_CONFIGURATION" - } - }, - "SECURITY_GROUPS_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECURITY_GROUPS_NOT_FOUND" - } - }, - "IGW_NOT_ATTACHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IGW_NOT_ATTACHED" - } - }, - "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION" - } - }, - "FLEET_STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLEET_STOPPED" - } - }, - "FLEET_INSTANCE_PROVISIONING_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLEET_INSTANCE_PROVISIONING_FAILURE" - } - }, - "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND" - } - }, - "DOMAIN_JOIN_ERROR_ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_ACCESS_DENIED" - } - }, - "DOMAIN_JOIN_ERROR_LOGON_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_LOGON_FAILURE" - } - }, - "DOMAIN_JOIN_ERROR_INVALID_PARAMETER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_INVALID_PARAMETER" - } - }, - "DOMAIN_JOIN_ERROR_MORE_DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_MORE_DATA" - } - }, - "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN" - } - }, - "DOMAIN_JOIN_ERROR_NOT_SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_NOT_SUPPORTED" - } - }, - "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME" - } - }, - "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED" - } - }, - "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED" - } - }, - "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED" - } - }, - "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR" - } - } - } - }, - "com.amazonaws.appstream#FleetErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#FleetError" - } - }, - "com.amazonaws.appstream#FleetList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Fleet" - }, - "traits": { - "smithy.api#documentation": "The fleets.
" - } - }, - "com.amazonaws.appstream#FleetState": { - "type": "enum", - "members": { - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.appstream#FleetType": { - "type": "enum", - "members": { - "ALWAYS_ON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALWAYS_ON" - } - }, - "ON_DEMAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ON_DEMAND" - } - }, - "ELASTIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ELASTIC" - } - } - } - }, - "com.amazonaws.appstream#Image": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image.
", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the image.
" - } - }, - "BaseImageArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the image from which this image was created.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The image name to display.
" - } - }, - "State": { - "target": "com.amazonaws.appstream#ImageState", - "traits": { - "smithy.api#documentation": "The image starts in the PENDING state. If image creation succeeds, the\n state is AVAILABLE. If image creation fails, the state is FAILED.
Indicates whether the image is public or private.
" - } - }, - "ImageBuilderSupported": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether an image builder can be launched from this image.
" - } - }, - "ImageBuilderName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The name of the image builder that was used to create the private image. If the image is shared, this value is null.
" - } - }, - "Platform": { - "target": "com.amazonaws.appstream#PlatformType", - "traits": { - "smithy.api#documentation": "The operating system platform of the image.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "StateChangeReason": { - "target": "com.amazonaws.appstream#ImageStateChangeReason", - "traits": { - "smithy.api#documentation": "The reason why the last state change occurred.
" - } - }, - "Applications": { - "target": "com.amazonaws.appstream#Applications", - "traits": { - "smithy.api#documentation": "The applications associated with the image.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time the image was created.
" - } - }, - "PublicBaseImageReleasedDate": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The release date of the public base image. \n For private images, this date is the release date of the base image from which the image was created.
" - } - }, - "AppstreamAgentVersion": { - "target": "com.amazonaws.appstream#AppstreamAgentVersion", - "traits": { - "smithy.api#documentation": "The version of the AppStream 2.0 agent to use for instances that are launched from this image.
" - } - }, - "ImagePermissions": { - "target": "com.amazonaws.appstream#ImagePermissions", - "traits": { - "smithy.api#documentation": "The permissions to provide to the destination AWS account for the specified image.
" - } - }, - "ImageErrors": { - "target": "com.amazonaws.appstream#ResourceErrors", - "traits": { - "smithy.api#documentation": "Describes the errors that are returned when a new image can't be created.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an image.
" - } - }, - "com.amazonaws.appstream#ImageBuilder": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image builder.
", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN for the image builder.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the image from which this builder was created.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The image builder name to display.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", - "traits": { - "smithy.api#documentation": "The VPC configuration of the image builder.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The instance type for the image builder. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe operating system platform of the image builder.
" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "State": { - "target": "com.amazonaws.appstream#ImageBuilderState", - "traits": { - "smithy.api#documentation": "The state of the image builder.
" - } - }, - "StateChangeReason": { - "target": "com.amazonaws.appstream#ImageBuilderStateChangeReason", - "traits": { - "smithy.api#documentation": "The reason why the last state change occurred.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time stamp when the image builder was created.
" - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Enables or disables default internet access for the image builder.
" - } - }, - "DomainJoinInfo": { - "target": "com.amazonaws.appstream#DomainJoinInfo", - "traits": { - "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
" - } - }, - "NetworkAccessConfiguration": { - "target": "com.amazonaws.appstream#NetworkAccessConfiguration" - }, - "ImageBuilderErrors": { - "target": "com.amazonaws.appstream#ResourceErrors", - "traits": { - "smithy.api#documentation": "The image builder errors.
" - } - }, - "AppstreamAgentVersion": { - "target": "com.amazonaws.appstream#AppstreamAgentVersion", - "traits": { - "smithy.api#documentation": "The version of the AppStream 2.0 agent that is currently being used by the image builder.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a virtual machine that is used to create an image.
" - } - }, - "com.amazonaws.appstream#ImageBuilderList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#ImageBuilder" - } - }, - "com.amazonaws.appstream#ImageBuilderState": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "UPDATING_AGENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING_AGENT" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - }, - "REBOOTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REBOOTING" - } - }, - "SNAPSHOTTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNAPSHOTTING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "PENDING_QUALIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_QUALIFICATION" - } - } - } - }, - "com.amazonaws.appstream#ImageBuilderStateChangeReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.appstream#ImageBuilderStateChangeReasonCode", - "traits": { - "smithy.api#documentation": "The state change reason code.
" - } - }, - "Message": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The state change reason message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the reason why the last image builder state change occurred.
" - } - }, - "com.amazonaws.appstream#ImageBuilderStateChangeReasonCode": { - "type": "enum", - "members": { - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - }, - "IMAGE_UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE_UNAVAILABLE" - } - } - } - }, - "com.amazonaws.appstream#ImageList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Image" - } - }, - "com.amazonaws.appstream#ImagePermissions": { - "type": "structure", - "members": { - "allowFleet": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Indicates whether the image can be used for a fleet.
" - } - }, - "allowImageBuilder": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Indicates whether the image can be used for an image builder.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the permissions for an image.
" - } - }, - "com.amazonaws.appstream#ImageState": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COPYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COPYING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "IMPORTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORTING" - } - } - } - }, - "com.amazonaws.appstream#ImageStateChangeReason": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.appstream#ImageStateChangeReasonCode", - "traits": { - "smithy.api#documentation": "The state change reason code.
" - } - }, - "Message": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The state change reason message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the reason why the last image state change occurred.
" - } - }, - "com.amazonaws.appstream#ImageStateChangeReasonCode": { - "type": "enum", - "members": { - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - }, - "IMAGE_BUILDER_NOT_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE_BUILDER_NOT_AVAILABLE" - } - }, - "IMAGE_COPY_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE_COPY_FAILURE" - } - } - } - }, - "com.amazonaws.appstream#IncompatibleImageException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The image can't be updated because it's not compatible for updates.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#Integer": { - "type": "integer" - }, - "com.amazonaws.appstream#InvalidAccountStatusException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#InvalidParameterCombinationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "Indicates an incorrect combination of parameters, or a missing parameter.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#InvalidRoleException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The specified role is invalid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#LastReportGenerationExecutionError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.appstream#UsageReportExecutionErrorCode", - "traits": { - "smithy.api#documentation": "The error code for the error that is returned when a usage report can't be generated.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The error message for the error that is returned when a usage report can't be generated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the error that is returned when a usage report can't be generated.
" - } - }, - "com.amazonaws.appstream#LastReportGenerationExecutionErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#LastReportGenerationExecutionError" - } - }, - "com.amazonaws.appstream#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The requested limit exceeds the permitted limit for an account.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#ListAssociatedFleets": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#ListAssociatedFleetsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#ListAssociatedFleetsResult" - }, - "traits": { - "smithy.api#documentation": "Retrieves the name of the fleet that is associated with the specified stack.
" - } - }, - "com.amazonaws.appstream#ListAssociatedFleetsRequest": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#ListAssociatedFleetsResult": { - "type": "structure", - "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The name of the fleet.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#ListAssociatedStacks": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#ListAssociatedStacksRequest" - }, - "output": { - "target": "com.amazonaws.appstream#ListAssociatedStacksResult" - }, - "traits": { - "smithy.api#documentation": "Retrieves the name of the stack with which the specified fleet is associated.
" - } - }, - "com.amazonaws.appstream#ListAssociatedStacksRequest": { - "type": "structure", - "members": { - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#ListAssociatedStacksResult": { - "type": "structure", - "members": { - "Names": { - "target": "com.amazonaws.appstream#StringList", - "traits": { - "smithy.api#documentation": "The name of the stack.
" - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "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#clientOptional": {}, - "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#clientOptional": {}, - "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.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "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.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.appstream#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "com.amazonaws.appstream#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#documentation": "The information about the tags.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#Long": { - "type": "long" - }, - "com.amazonaws.appstream#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.appstream#MessageAction": { - "type": "enum", - "members": { - "SUPPRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUPPRESS" - } - }, - "RESEND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESEND" - } - } - } - }, - "com.amazonaws.appstream#Metadata": { - "type": "map", - "key": { - "target": "com.amazonaws.appstream#String" - }, - "value": { - "target": "com.amazonaws.appstream#String" - } - }, - "com.amazonaws.appstream#Name": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$" - } - }, - "com.amazonaws.appstream#NetworkAccessConfiguration": { - "type": "structure", - "members": { - "EniPrivateIpAddress": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The private IP address of the elastic network interface that is attached to instances in your VPC.
" - } - }, - "EniId": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the network details of the fleet or image builder instance.
" - } - }, - "com.amazonaws.appstream#OperationNotPermittedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The attempted operation is not permitted.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#OrganizationalUnitDistinguishedName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedName" - } - }, - "com.amazonaws.appstream#PackagingType": { - "type": "enum", - "members": { - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - }, - "APPSTREAM2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPSTREAM2" - } - } - } - }, - "com.amazonaws.appstream#Permission": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.appstream#PhotonAdminProxyService": { - "type": "service", - "version": "2016-12-01", - "operations": [ - { - "target": "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlock" + "com.amazonaws.appstream#ApplicationSettingsResponse": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether persistent application settings are enabled for users during their streaming sessions.
" + } + }, + "SettingsGroup": { + "target": "com.amazonaws.appstream#SettingsGroup", + "traits": { + "smithy.api#documentation": "The path prefix for the S3 bucket where users’ persistent application settings are stored.
" + } + }, + "S3BucketName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the persistent application settings for users of a stack.
" + } + }, + "com.amazonaws.appstream#Applications": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Application" + } + }, + "com.amazonaws.appstream#AppstreamAgentVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.appstream#Arn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws(?:\\-cn|\\-iso\\-b|\\-iso|\\-us\\-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$" + } + }, + "com.amazonaws.appstream#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Arn" + } + }, + "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockRequest" + }, + "output": { + "target": "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified app block builder with the specified app block.
" + } + }, + "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockRequest": { + "type": "structure", + "members": { + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlockResult": { + "type": "structure", + "members": { + "AppBlockBuilderAppBlockAssociation": { + "target": "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociation", + "traits": { + "smithy.api#documentation": "The list of app block builders associated with app blocks.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#AssociateApplicationFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#AssociateApplicationFleetRequest" + }, + "output": { + "target": "com.amazonaws.appstream#AssociateApplicationFleetResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
" + } + }, + "com.amazonaws.appstream#AssociateApplicationFleetRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#AssociateApplicationFleetResult": { + "type": "structure", + "members": { + "ApplicationFleetAssociation": { + "target": "com.amazonaws.appstream#ApplicationFleetAssociation", + "traits": { + "smithy.api#documentation": "If fleet name is specified, this returns the list of applications that are associated\n to it. If application ARN is specified, this returns the list of fleets to which it is\n associated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#AssociateApplicationToEntitlement": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#AssociateApplicationToEntitlementRequest" + }, + "output": { + "target": "com.amazonaws.appstream#AssociateApplicationToEntitlementResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#EntitlementNotFoundException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Associates an application to entitle.
" + } + }, + "com.amazonaws.appstream#AssociateApplicationToEntitlementRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "EntitlementName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#AssociateApplicationToEntitlementResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#AssociateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#AssociateFleetRequest" + }, + "output": { + "target": "com.amazonaws.appstream#AssociateFleetResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified fleet with the specified stack.
" + } + }, + "com.amazonaws.appstream#AssociateFleetRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#AssociateFleetResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#AuthenticationType": { + "type": "enum", + "members": { + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API" + } + }, + "SAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAML" + } + }, + "USERPOOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USERPOOL" + } + }, + "AWS_AD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_AD" + } + } + } + }, + "com.amazonaws.appstream#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d+$" + } + }, + "com.amazonaws.appstream#AwsAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#AwsAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.appstream#BatchAssociateUserStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#BatchAssociateUserStackRequest" + }, + "output": { + "target": "com.amazonaws.appstream#BatchAssociateUserStackResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], + "traits": { + "smithy.api#documentation": "Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
" + } + }, + "com.amazonaws.appstream#BatchAssociateUserStackRequest": { + "type": "structure", + "members": { + "UserStackAssociations": { + "target": "com.amazonaws.appstream#UserStackAssociationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of UserStackAssociation objects.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#BatchAssociateUserStackResult": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.appstream#UserStackAssociationErrorList", + "traits": { + "smithy.api#documentation": "The list of UserStackAssociationError objects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#BatchDisassociateUserStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#BatchDisassociateUserStackRequest" + }, + "output": { + "target": "com.amazonaws.appstream#BatchDisassociateUserStackResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates the specified users from the specified stacks.
" + } + }, + "com.amazonaws.appstream#BatchDisassociateUserStackRequest": { + "type": "structure", + "members": { + "UserStackAssociations": { + "target": "com.amazonaws.appstream#UserStackAssociationList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The list of UserStackAssociation objects.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#BatchDisassociateUserStackResult": { + "type": "structure", + "members": { + "errors": { + "target": "com.amazonaws.appstream#UserStackAssociationErrorList", + "traits": { + "smithy.api#documentation": "The list of UserStackAssociationError objects.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#Boolean": { + "type": "boolean" + }, + "com.amazonaws.appstream#BooleanObject": { + "type": "boolean" + }, + "com.amazonaws.appstream#CertificateBasedAuthProperties": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.appstream#CertificateBasedAuthStatus", + "traits": { + "smithy.api#documentation": "The status of the certificate-based authentication properties.
" + } + }, + "CertificateAuthorityArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the AWS Certificate Manager Private CA resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" + } + }, + "com.amazonaws.appstream#CertificateBasedAuthStatus": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "ENABLED_NO_DIRECTORY_LOGIN_FALLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED_NO_DIRECTORY_LOGIN_FALLBACK" + } + } + } + }, + "com.amazonaws.appstream#ComputeCapacity": { + "type": "structure", + "members": { + "DesiredInstances": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The desired number of streaming instances.
" + } + }, + "DesiredSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets.
\nWhen you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the capacity for a fleet.
" + } + }, + "com.amazonaws.appstream#ComputeCapacityStatus": { + "type": "structure", + "members": { + "Desired": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The desired number of streaming instances.
", + "smithy.api#required": {} + } + }, + "Running": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The total number of simultaneous streaming instances that are running.
" + } + }, + "InUse": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The number of instances in use for streaming.
" + } + }, + "Available": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The number of currently available instances that can be used to stream\n sessions.
" + } + }, + "DesiredUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state.
\nDesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity
\nThis only applies to multi-session fleets.
" + } + }, + "AvailableUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The number of idle session slots currently available for user sessions.
\nAvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions
\nThis only applies to multi-session fleets.
" + } + }, + "ActiveUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
" + } + }, + "ActualUserSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The total number of session slots that are available for streaming or are currently streaming.
\nActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions
\nThis only applies to multi-session fleets.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the capacity status for a fleet.
" + } + }, + "com.amazonaws.appstream#ConcurrentModificationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "An API error occurred. Wait a few minutes and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appstream#CopyImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CopyImageRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CopyImageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
" + } + }, + "com.amazonaws.appstream#CopyImageRequest": { + "type": "structure", + "members": { + "SourceImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image to copy.
", + "smithy.api#required": {} + } + }, + "DestinationImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name that the image will have when it is copied to the destination.
", + "smithy.api#required": {} + } + }, + "DestinationRegion": { + "target": "com.amazonaws.appstream#RegionName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
", + "smithy.api#required": {} + } + }, + "DestinationImageDescription": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description that the image will have when it is copied to the destination.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CopyImageResponse": { + "type": "structure", + "members": { + "DestinationImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the destination image.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateAppBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateAppBlockRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateAppBlockResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an app block.
\nApp blocks are an Amazon AppStream 2.0 resource that stores the details about the\n virtual hard disk in an S3 bucket. It also stores the setup script with details about\n how to mount the virtual hard disk. The virtual hard disk includes the application\n binaries and other files necessary to launch your applications. Multiple applications\n can be assigned to a single app block.
\nThis is only supported for Elastic fleets.
" + } + }, + "com.amazonaws.appstream#CreateAppBlockBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateAppBlockBuilderRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateAppBlockBuilderResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an app block builder.
" + } + }, + "com.amazonaws.appstream#CreateAppBlockBuilderRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The unique name for the app block builder.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the app block builder.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the app block builder.
" + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags to associate with the app block builder. A tag is a key-value pair, and the\n value is optional. For example, Environment=Test. If you do not specify a value,\n Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nFor more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "Platform": { + "target": "com.amazonaws.appstream#AppBlockBuilderPlatformType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The platform of the app block builder.
\n\n WINDOWS_SERVER_2019 is the only valid value.
The instance type to use when launching the app block builder. The following instance\n types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe VPC configuration for the app block builder.
\nApp block builders require that you specify at least two subnets in different availability\n zones.
", + "smithy.api#required": {} + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Enables or disables default internet access for the app block builder.
" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To\n assume a role, the app block builder calls the AWS Security Token Service (STS)\n AssumeRole API operation and passes the ARN of the role to use. The\n operation creates a new session with temporary credentials. AppStream 2.0 retrieves the\n temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateAppBlockBuilderResult": { + "type": "structure", + "members": { + "AppBlockBuilder": { + "target": "com.amazonaws.appstream#AppBlockBuilder" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURL": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a URL to start a create app block builder streaming session.
" + } + }, + "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLRequest": { + "type": "structure", + "members": { + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + }, + "Validity": { + "target": "com.amazonaws.appstream#Long", + "traits": { + "smithy.api#documentation": "The time that the streaming URL will be valid, in seconds. \n Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURLResult": { + "type": "structure", + "members": { + "StreamingURL": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The URL to start the streaming session.
" + } + }, + "Expires": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The elapsed time, in seconds after the Unix epoch, when this URL expires.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateAppBlockRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the app block.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the app block. This is not displayed to the user.
" + } + }, + "SourceS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The source S3 location of the app block.
", + "smithy.api#required": {} + } + }, + "SetupScriptDetails": { + "target": "com.amazonaws.appstream#ScriptDetails", + "traits": { + "smithy.api#documentation": "The setup script details of the app block. This must be provided for the\n CUSTOM PackagingType.
The tags assigned to the app block.
" + } + }, + "PostSetupScriptDetails": { + "target": "com.amazonaws.appstream#ScriptDetails", + "traits": { + "smithy.api#documentation": "The post setup script details of the app block. This can only be provided for the\n APPSTREAM2 PackagingType.
The packaging type of the app block.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateAppBlockResult": { + "type": "structure", + "members": { + "AppBlock": { + "target": "com.amazonaws.appstream#AppBlock", + "traits": { + "smithy.api#documentation": "The app block.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an application.
\nApplications are an Amazon AppStream 2.0 resource that stores the details about how to\n launch applications on Elastic fleet streaming instances. An application consists of the\n launch details, icon, and display name. Applications are associated with an app block\n that contains the application binaries and other files. The applications assigned to an\n Elastic fleet are the applications users can launch.
\nThis is only supported for Elastic fleets.
" + } + }, + "com.amazonaws.appstream#CreateApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the application. This name is visible to users when display name is not specified.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the application. This name is visible to users in the application catalog.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "IconS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The location in S3 of the application icon.
", + "smithy.api#required": {} + } + }, + "LaunchPath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The launch path of the application.
", + "smithy.api#required": {} + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The working directory of the application.
" + } + }, + "LaunchParameters": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The launch parameters of the application.
" + } + }, + "Platforms": { + "target": "com.amazonaws.appstream#Platforms", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
", + "smithy.api#required": {} + } + }, + "InstanceFamilies": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
", + "smithy.api#required": {} + } + }, + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The app block ARN to which the application should be associated
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags assigned to the application.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateApplicationResult": { + "type": "structure", + "members": { + "Application": { + "target": "com.amazonaws.appstream#Application" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateDirectoryConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateDirectoryConfigRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateDirectoryConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" + } + }, + "com.amazonaws.appstream#CreateDirectoryConfigRequest": { + "type": "structure", + "members": { + "DirectoryName": { + "target": "com.amazonaws.appstream#DirectoryName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The fully qualified name of the directory (for example, corp.example.com).
", + "smithy.api#required": {} + } + }, + "OrganizationalUnitDistinguishedNames": { + "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The distinguished names of the organizational units for computer accounts.
", + "smithy.api#required": {} + } + }, + "ServiceAccountCredentials": { + "target": "com.amazonaws.appstream#ServiceAccountCredentials", + "traits": { + "smithy.api#documentation": "The credentials for the service account used by the fleet or image builder to connect to the directory.
" + } + }, + "CertificateBasedAuthProperties": { + "target": "com.amazonaws.appstream#CertificateBasedAuthProperties", + "traits": { + "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateDirectoryConfigResult": { + "type": "structure", + "members": { + "DirectoryConfig": { + "target": "com.amazonaws.appstream#DirectoryConfig", + "traits": { + "smithy.api#documentation": "Information about the directory configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "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#clientOptional": {}, + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "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#clientOptional": {}, + "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The attributes of the entitlement.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateEntitlementResult": { + "type": "structure", + "members": { + "Entitlement": { + "target": "com.amazonaws.appstream#Entitlement", + "traits": { + "smithy.api#documentation": "The entitlement.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateFleetRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateFleetResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
" + } + }, + "com.amazonaws.appstream#CreateFleetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A unique name for the fleet.
", + "smithy.api#required": {} + } + }, + "ImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the image used to create the fleet.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the public, private, or shared image to use.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe following instance types are available for Elastic fleets:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe fleet type.
\nProvides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.
\nProvide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.
\nThe desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
" + } + }, + "MaxUserDurationInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
\nSpecify a value between 600 and 432000.
" + } + }, + "DisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
\nSpecify a value between 60 and 360000.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The fleet name to display.
" + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Enables or disables default internet access for the fleet.
" + } + }, + "DomainJoinInfo": { + "target": "com.amazonaws.appstream#DomainJoinInfo", + "traits": { + "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
" + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nFor more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "IdleDisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n they try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "StreamView": { + "target": "com.amazonaws.appstream#StreamView", + "traits": { + "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic\n fleets.
" + } + }, + "MaxConcurrentSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum concurrent sessions of the Elastic fleet. This is required for Elastic\n fleets, and not allowed for other fleet types.
" + } + }, + "UsbDeviceFilterStrings": { + "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", + "traits": { + "smithy.api#documentation": "The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
" + } + }, + "SessionScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
" + } + }, + "MaxSessionsPerInstance": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateFleetResult": { + "type": "structure", + "members": { + "Fleet": { + "target": "com.amazonaws.appstream#Fleet", + "traits": { + "smithy.api#documentation": "Information about the fleet.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateImageBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateImageBuilderRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateImageBuilderResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an image builder. An image builder is a virtual machine that is used to create an image.
\nThe initial state of the builder is PENDING. When it is ready, the state is RUNNING.
A unique name for the image builder.
", + "smithy.api#required": {} + } + }, + "ImageName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the image used to create the image builder.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the public, private, or shared image to use.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type to use when launching the image builder. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe description to display.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The image builder name to display.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the image builder. You can specify only one subnet.
" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Enables or disables default internet access for the image builder.
" + } + }, + "DomainJoinInfo": { + "target": "com.amazonaws.appstream#DomainJoinInfo", + "traits": { + "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
" + } + }, + "AppstreamAgentVersion": { + "target": "com.amazonaws.appstream#AppstreamAgentVersion", + "traits": { + "smithy.api#documentation": "The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
" + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nIf you do not specify a value, the value is set to an empty string.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateImageBuilderResult": { + "type": "structure", + "members": { + "ImageBuilder": { + "target": "com.amazonaws.appstream#ImageBuilder", + "traits": { + "smithy.api#documentation": "Information about the image builder.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateImageBuilderStreamingURL": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateImageBuilderStreamingURLRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateImageBuilderStreamingURLResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a URL to start an image builder streaming session.
" + } + }, + "com.amazonaws.appstream#CreateImageBuilderStreamingURLRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image builder.
", + "smithy.api#required": {} + } + }, + "Validity": { + "target": "com.amazonaws.appstream#Long", + "traits": { + "smithy.api#documentation": "The time that the streaming URL will be valid, in seconds. \n Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateImageBuilderStreamingURLResult": { + "type": "structure", + "members": { + "StreamingURL": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The URL to start the AppStream 2.0 streaming session.
" + } + }, + "Expires": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The elapsed time, in seconds after the Unix epoch, when this URL expires.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateStackRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateStackResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
" + } + }, + "com.amazonaws.appstream#CreateStackRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The stack name to display.
" + } + }, + "StorageConnectors": { + "target": "com.amazonaws.appstream#StorageConnectorList", + "traits": { + "smithy.api#documentation": "The storage connectors to enable.
" + } + }, + "RedirectURL": { + "target": "com.amazonaws.appstream#RedirectURL", + "traits": { + "smithy.api#documentation": "The URL that users are redirected to after their streaming session ends.
" + } + }, + "FeedbackURL": { + "target": "com.amazonaws.appstream#FeedbackURL", + "traits": { + "smithy.api#documentation": "The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
" + } + }, + "UserSettings": { + "target": "com.amazonaws.appstream#UserSettingList", + "traits": { + "smithy.api#documentation": "The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
" + } + }, + "ApplicationSettings": { + "target": "com.amazonaws.appstream#ApplicationSettings", + "traits": { + "smithy.api#documentation": "The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
" + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
" + } + }, + "EmbedHostDomains": { + "target": "com.amazonaws.appstream#EmbedHostDomains", + "traits": { + "smithy.api#documentation": "The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
" + } + }, + "StreamingExperienceSettings": { + "target": "com.amazonaws.appstream#StreamingExperienceSettings", + "traits": { + "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateStackResult": { + "type": "structure", + "members": { + "Stack": { + "target": "com.amazonaws.appstream#Stack", + "traits": { + "smithy.api#documentation": "Information about the stack.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateStreamingURL": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateStreamingURLRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateStreamingURLResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
" + } + }, + "com.amazonaws.appstream#CreateStreamingURLRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.appstream#StreamingUrlUserId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier of the user.
", + "smithy.api#required": {} + } + }, + "ApplicationId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the application to launch after the session starts. This is the name that you specified\n as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.
" + } + }, + "Validity": { + "target": "com.amazonaws.appstream#Long", + "traits": { + "smithy.api#documentation": "The time that the streaming URL will be valid, in seconds.\n Specify a value between 1 and 604800 seconds. The default is 60 seconds.
" + } + }, + "SessionContext": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateStreamingURLResult": { + "type": "structure", + "members": { + "StreamingURL": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The URL to start the AppStream 2.0 streaming session.
" + } + }, + "Expires": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The elapsed time, in seconds after the Unix epoch, when this URL expires.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateUpdatedImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateUpdatedImageRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateUpdatedImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software.
\nFor more information, see the \"Update an Image by Using\n Managed AppStream 2.0 Image Updates\" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "com.amazonaws.appstream#CreateUpdatedImageRequest": { + "type": "structure", + "members": { + "existingImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image to update.
", + "smithy.api#required": {} + } + }, + "newImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the new image. The name must be unique within the AWS account and Region.
", + "smithy.api#required": {} + } + }, + "newImageDescription": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description to display for the new image.
" + } + }, + "newImageDisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The name to display for the new image.
" + } + }, + "newImageTags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
\nIf you do not specify a value, the value is set to an empty string.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "dryRun": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.
Indicates whether a new image can be created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateUsageReportSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateUsageReportSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateUsageReportSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a usage report subscription. Usage reports are generated daily.
" + } + }, + "com.amazonaws.appstream#CreateUsageReportSubscriptionRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateUsageReportSubscriptionResult": { + "type": "structure", + "members": { + "S3BucketName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket where generated reports are stored.
\nIf you enabled on-instance session scripts and Amazon S3 logging for your session script\n configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is\n unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0\n uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, \n when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
" + } + }, + "Schedule": { + "target": "com.amazonaws.appstream#UsageReportSchedule", + "traits": { + "smithy.api#documentation": "The schedule for generating usage reports.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new user in the user pool.
" + } + }, + "com.amazonaws.appstream#CreateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.
\nThe action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
\nThe temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
\nThe first name, or given name, of the user.
" + } + }, + "LastName": { + "target": "com.amazonaws.appstream#UserAttributeValue", + "traits": { + "smithy.api#documentation": "The last name, or surname, of the user.
" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The authentication type for the user. You must specify USERPOOL.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#CreateUserResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteAppBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteAppBlockRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteAppBlockResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an app block.
" + } + }, + "com.amazonaws.appstream#DeleteAppBlockBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteAppBlockBuilderRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteAppBlockBuilderResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an app block builder.
\nAn app block builder can only be deleted when it has no association with an app\n block.
" + } + }, + "com.amazonaws.appstream#DeleteAppBlockBuilderRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteAppBlockBuilderResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteAppBlockRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteAppBlockResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an application.
" + } + }, + "com.amazonaws.appstream#DeleteApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteApplicationResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteDirectoryConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteDirectoryConfigRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteDirectoryConfigResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
" + } + }, + "com.amazonaws.appstream#DeleteDirectoryConfigRequest": { + "type": "structure", + "members": { + "DirectoryName": { + "target": "com.amazonaws.appstream#DirectoryName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the directory configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteDirectoryConfigResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "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#clientOptional": {}, + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteEntitlementResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteFleetRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteFleetResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified fleet.
" + } + }, + "com.amazonaws.appstream#DeleteFleetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteFleetResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteImageRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteImageResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified image. You cannot delete an image when it is in use. \n After you delete an image, you cannot provision new capacity using the image.
" + } + }, + "com.amazonaws.appstream#DeleteImageBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteImageBuilderRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteImageBuilderResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified image builder and releases the capacity.
" + } + }, + "com.amazonaws.appstream#DeleteImageBuilderRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image builder.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteImageBuilderResult": { + "type": "structure", + "members": { + "ImageBuilder": { + "target": "com.amazonaws.appstream#ImageBuilder", + "traits": { + "smithy.api#documentation": "Information about the image builder.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteImagePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteImagePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteImagePermissionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
" + } + }, + "com.amazonaws.appstream#DeleteImagePermissionsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the private image.
", + "smithy.api#required": {} + } + }, + "SharedAccountId": { + "target": "com.amazonaws.appstream#AwsAccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The 12-digit identifier of the AWS account for which to delete image permissions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteImagePermissionsResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteImageRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteImageResult": { + "type": "structure", + "members": { + "Image": { + "target": "com.amazonaws.appstream#Image", + "traits": { + "smithy.api#documentation": "Information about the image.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteStackRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteStackResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
" + } + }, + "com.amazonaws.appstream#DeleteStackRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteStackResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteUsageReportSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteUsageReportSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteUsageReportSubscriptionResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disables usage report generation.
" + } + }, + "com.amazonaws.appstream#DeleteUsageReportSubscriptionRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteUsageReportSubscriptionResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteUserRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a user from the user pool.
" + } + }, + "com.amazonaws.appstream#DeleteUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user. You must specify USERPOOL.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DeleteUserResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more app block builder associations.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsRequest": { + "type": "structure", + "members": { + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the app block.
" + } + }, + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the app block builder.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociationsResult": { + "type": "structure", + "members": { + "AppBlockBuilderAppBlockAssociations": { + "target": "com.amazonaws.appstream#AppBlockBuilderAppBlockAssociationsList", + "traits": { + "smithy.api#documentation": "This list of app block builders associated with app blocks.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeAppBlockBuilders": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeAppBlockBuildersRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeAppBlockBuildersResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more app block builders.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.appstream#DescribeAppBlockBuildersRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The names of the app block builders.
" + } + }, + "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.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results. The maximum value is 25.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeAppBlockBuildersResult": { + "type": "structure", + "members": { + "AppBlockBuilders": { + "target": "com.amazonaws.appstream#AppBlockBuilderList", + "traits": { + "smithy.api#documentation": "The list that describes one or more app block builders.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeAppBlocks": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeAppBlocksRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeAppBlocksResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more app blocks.
" + } + }, + "com.amazonaws.appstream#DescribeAppBlocksRequest": { + "type": "structure", + "members": { + "Arns": { + "target": "com.amazonaws.appstream#ArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the app blocks.
" + } + }, + "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.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeAppBlocksResult": { + "type": "structure", + "members": { + "AppBlocks": { + "target": "com.amazonaws.appstream#AppBlocks", + "traits": { + "smithy.api#documentation": "The app blocks in the list.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeApplicationFleetAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
" + } + }, + "com.amazonaws.appstream#DescribeApplicationFleetAssociationsRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the fleet.
" + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the application.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeApplicationFleetAssociationsResult": { + "type": "structure", + "members": { + "ApplicationFleetAssociations": { + "target": "com.amazonaws.appstream#ApplicationFleetAssociationList", + "traits": { + "smithy.api#documentation": "The application fleet associations in the list.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeApplicationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more applications.
" + } + }, + "com.amazonaws.appstream#DescribeApplicationsRequest": { + "type": "structure", + "members": { + "Arns": { + "target": "com.amazonaws.appstream#ArnList", + "traits": { + "smithy.api#documentation": "The ARNs for the applications.
" + } + }, + "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.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeApplicationsResult": { + "type": "structure", + "members": { + "Applications": { + "target": "com.amazonaws.appstream#Applications", + "traits": { + "smithy.api#documentation": "The applications in the list.
" + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeDirectoryConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeDirectoryConfigsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeDirectoryConfigsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. \n
\nAlthough the response syntax in this topic includes the account password, this password is not returned in the actual response.
" + } + }, + "com.amazonaws.appstream#DescribeDirectoryConfigsRequest": { + "type": "structure", + "members": { + "DirectoryNames": { + "target": "com.amazonaws.appstream#DirectoryNameList", + "traits": { + "smithy.api#documentation": "The directory names.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeDirectoryConfigsResult": { + "type": "structure", + "members": { + "DirectoryConfigs": { + "target": "com.amazonaws.appstream#DirectoryConfigList", + "traits": { + "smithy.api#documentation": "Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "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#clientOptional": {}, + "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.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeFleetsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeFleetsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
", + "smithy.waiters#waitable": { + "FleetStarted": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "RUNNING", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "STOPPING", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "STOPPED", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "FleetStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "STOPPED", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "STARTING", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "RUNNING", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.appstream#DescribeFleetsRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The names of the fleets to describe.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeFleetsResult": { + "type": "structure", + "members": { + "Fleets": { + "target": "com.amazonaws.appstream#FleetList", + "traits": { + "smithy.api#documentation": "Information about the fleets.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeImageBuilders": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeImageBuildersRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeImageBuildersResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
" + } + }, + "com.amazonaws.appstream#DescribeImageBuildersRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The names of the image builders to describe.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeImageBuildersResult": { + "type": "structure", + "members": { + "ImageBuilders": { + "target": "com.amazonaws.appstream#ImageBuilderList", + "traits": { + "smithy.api#documentation": "Information about the image builders.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeImagePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeImagePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeImagePermissionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.appstream#DescribeImagePermissionsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the private image for which to describe permissions. The image must be one that you own.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "SharedAwsAccountIds": { + "target": "com.amazonaws.appstream#AwsAccountIdList", + "traits": { + "smithy.api#documentation": "The 12-digit identifier of one or more AWS accounts with which the image is shared.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeImagePermissionsResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the private image.
" + } + }, + "SharedImagePermissionsList": { + "target": "com.amazonaws.appstream#SharedImagePermissionsList", + "traits": { + "smithy.api#documentation": "The permissions for a private image that you own.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeImages": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeImagesRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeImagesResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.appstream#DescribeImagesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.appstream#DescribeImagesRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The names of the public or private images to describe.
" + } + }, + "Arns": { + "target": "com.amazonaws.appstream#ArnList", + "traits": { + "smithy.api#documentation": "The ARNs of the public, private, and shared images to describe.
" + } + }, + "Type": { + "target": "com.amazonaws.appstream#VisibilityType", + "traits": { + "smithy.api#documentation": "The type of image (public, private, or shared) to describe.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#DescribeImagesMaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeImagesResult": { + "type": "structure", + "members": { + "Images": { + "target": "com.amazonaws.appstream#ImageList", + "traits": { + "smithy.api#documentation": "Information about the images.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeSessionsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeSessionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet,\n only streaming sessions for that user are described. If an authentication type is not provided, \n the default is to authenticate users using a streaming URL.
" + } + }, + "com.amazonaws.appstream#DescribeSessionsRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack. This value is case-sensitive.
", + "smithy.api#required": {} + } + }, + "FleetName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet. This value is case-sensitive.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.appstream#UserId", + "traits": { + "smithy.api#documentation": "The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + }, + "Limit": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The size of each page of results. The default value is 20 and the maximum value is 50.
" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication method. Specify API for a user\n authenticated using a streaming URL or SAML for a SAML federated user. \n The default is to authenticate users using a streaming URL.
The identifier for the instance hosting the session.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeSessionsResult": { + "type": "structure", + "members": { + "Sessions": { + "target": "com.amazonaws.appstream#SessionList", + "traits": { + "smithy.api#documentation": "Information about the streaming sessions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeStacks": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeStacksRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeStacksResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
" + } + }, + "com.amazonaws.appstream#DescribeStacksRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The names of the stacks to describe.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeStacksResult": { + "type": "structure", + "members": { + "Stacks": { + "target": "com.amazonaws.appstream#StackList", + "traits": { + "smithy.api#documentation": "Information about the stacks.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeUsageReportSubscriptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeUsageReportSubscriptionsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeUsageReportSubscriptionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more usage report subscriptions.
" + } + }, + "com.amazonaws.appstream#DescribeUsageReportSubscriptionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeUsageReportSubscriptionsResult": { + "type": "structure", + "members": { + "UsageReportSubscriptions": { + "target": "com.amazonaws.appstream#UsageReportSubscriptionList", + "traits": { + "smithy.api#documentation": "Information about the usage report subscription.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeUserStackAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeUserStackAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeUserStackAssociationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:
\nThe stack name
\nThe user name (email address of the user associated with the stack) and the authentication type for the user
\nThe name of the stack that is associated with the user.
" + } + }, + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#documentation": "The email address of the user who is associated with the stack.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user who is associated with the stack. You must specify USERPOOL.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeUserStackAssociationsResult": { + "type": "structure", + "members": { + "UserStackAssociations": { + "target": "com.amazonaws.appstream#UserStackAssociationList", + "traits": { + "smithy.api#documentation": "The UserStackAssociation objects.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DescribeUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeUsersRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeUsersResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one or more specified users in the user pool.
" + } + }, + "com.amazonaws.appstream#DescribeUsersRequest": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The authentication type for the users in the user pool to describe. You must specify USERPOOL.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DescribeUsersResult": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.appstream#UserList", + "traits": { + "smithy.api#documentation": "Information about users in the user pool.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.appstream#DirectoryConfig": { + "type": "structure", + "members": { + "DirectoryName": { + "target": "com.amazonaws.appstream#DirectoryName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The fully qualified name of the directory (for example, corp.example.com).
", + "smithy.api#required": {} + } + }, + "OrganizationalUnitDistinguishedNames": { + "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", + "traits": { + "smithy.api#documentation": "The distinguished names of the organizational units for computer accounts.
" + } + }, + "ServiceAccountCredentials": { + "target": "com.amazonaws.appstream#ServiceAccountCredentials", + "traits": { + "smithy.api#documentation": "The credentials for the service account used by the fleet or image builder to connect to the directory.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time the directory configuration was created.
" + } + }, + "CertificateBasedAuthProperties": { + "target": "com.amazonaws.appstream#CertificateBasedAuthProperties", + "traits": { + "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" + } + }, + "com.amazonaws.appstream#DirectoryConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#DirectoryConfig" + } + }, + "com.amazonaws.appstream#DirectoryName": { + "type": "string" + }, + "com.amazonaws.appstream#DirectoryNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#DirectoryName" + } + }, + "com.amazonaws.appstream#DisableUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DisableUserRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DisableUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
" + } + }, + "com.amazonaws.appstream#DisableUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user. You must specify USERPOOL.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DisableUserResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlock": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates a specified app block builder from a specified app block.
" + } + }, + "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockRequest": { + "type": "structure", + "members": { + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlockResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DisassociateApplicationFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DisassociateApplicationFleetRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DisassociateApplicationFleetResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates the specified application from the fleet.
" + } + }, + "com.amazonaws.appstream#DisassociateApplicationFleetRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DisassociateApplicationFleetResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "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#clientOptional": {}, + "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#clientOptional": {}, + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier of the application to remove from the entitlement.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DisassociateApplicationFromEntitlementResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DisassociateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DisassociateFleetRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DisassociateFleetResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates the specified fleet from the specified stack.
" + } + }, + "com.amazonaws.appstream#DisassociateFleetRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#DisassociateFleetResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.appstream#Domain": { + "type": "string", + "traits": { + "smithy.api#documentation": "GSuite domain for GDrive integration.", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.appstream#DomainJoinInfo": { + "type": "structure", + "members": { + "DirectoryName": { + "target": "com.amazonaws.appstream#DirectoryName", + "traits": { + "smithy.api#documentation": "The fully qualified name of the directory (for example, corp.example.com).
" + } + }, + "OrganizationalUnitDistinguishedName": { + "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedName", + "traits": { + "smithy.api#documentation": "The distinguished name of the organizational unit for computer accounts.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" + } + }, + "com.amazonaws.appstream#DomainList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Domain" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.appstream#EmbedHostDomain": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specifies a valid domain that can embed AppStream.\n Valid examples include: [\"testorigin.tt--com\", \"testingorigin.com.us\", \"test.com.us\"]\n Invalid examples include: [\"test,com\", \".com\", \"h*llo.com\". \"\"]", + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" + } + }, + "com.amazonaws.appstream#EmbedHostDomains": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#EmbedHostDomain" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.appstream#EnableUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#EnableUserRequest" + }, + "output": { + "target": "com.amazonaws.appstream#EnableUserResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
" + } + }, + "com.amazonaws.appstream#EnableUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.
\nThe authentication type for the user. You must specify USERPOOL.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#EnableUserResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#EntitledApplication": { + "type": "structure", + "members": { + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "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#clientOptional": {}, + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "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#clientOptional": {}, + "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#clientOptional": {}, + "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#clientOptional": {}, + "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#clientOptional": {}, + "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#ErrorDetails": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The error details.
" + } + }, + "com.amazonaws.appstream#ErrorDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#ErrorDetails" + } + }, + "com.amazonaws.appstream#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#documentation": "The error message in the exception.
" + } + }, + "com.amazonaws.appstream#ExpireSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#ExpireSessionRequest" + }, + "output": { + "target": "com.amazonaws.appstream#ExpireSessionResult" + }, + "traits": { + "smithy.api#documentation": "Immediately stops the specified streaming session.
" + } + }, + "com.amazonaws.appstream#ExpireSessionRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier of the streaming session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#ExpireSessionResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#FeedbackURL": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.appstream#Fleet": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the fleet.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The fleet name to display.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "ImageName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the image used to create the fleet.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN for the public, private, or shared image.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe fleet type.
\nProvides users with instant-on access to their apps.\n You are charged for all running instances in your fleet, even if no users are streaming apps.
\nProvide users with access to applications after they connect, which takes one to two minutes.\n You are charged for instance streaming when users are connected and a\n small hourly fee for instances that are not streaming apps.
\nThe capacity status for the fleet.
", + "smithy.api#required": {} + } + }, + "MaxUserDurationInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
\nSpecify a value between 600 and 360000.
" + } + }, + "DisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
\nSpecify a value between 60 and 360000.
" + } + }, + "State": { + "target": "com.amazonaws.appstream#FleetState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current state for the fleet.
", + "smithy.api#required": {} + } + }, + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the fleet.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time the fleet was created.
" + } + }, + "FleetErrors": { + "target": "com.amazonaws.appstream#FleetErrors", + "traits": { + "smithy.api#documentation": "The fleet errors.
" + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Indicates whether default internet access is enabled for the fleet.
" + } + }, + "DomainJoinInfo": { + "target": "com.amazonaws.appstream#DomainJoinInfo", + "traits": { + "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
" + } + }, + "IdleDisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "StreamView": { + "target": "com.amazonaws.appstream#StreamView", + "traits": { + "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The platform of the fleet.
" + } + }, + "MaxConcurrentSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for the fleet.
" + } + }, + "UsbDeviceFilterStrings": { + "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", + "traits": { + "smithy.api#documentation": "The USB device filter strings associated with the fleet.
" + } + }, + "SessionScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
" + } + }, + "MaxSessionsPerInstance": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a fleet.
" + } + }, + "com.amazonaws.appstream#FleetAttribute": { + "type": "enum", + "members": { + "VPC_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_CONFIGURATION" + } + }, + "VPC_CONFIGURATION_SECURITY_GROUP_IDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_CONFIGURATION_SECURITY_GROUP_IDS" + } + }, + "DOMAIN_JOIN_INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_INFO" + } + }, + "IAM_ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE_ARN" + } + }, + "USB_DEVICE_FILTER_STRINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USB_DEVICE_FILTER_STRINGS" + } + }, + "SESSION_SCRIPT_S3_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SESSION_SCRIPT_S3_LOCATION" + } + }, + "MAX_SESSIONS_PER_INSTANCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_SESSIONS_PER_INSTANCE" + } + } + }, + "traits": { + "smithy.api#documentation": "The fleet attribute.
" + } + }, + "com.amazonaws.appstream#FleetAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#FleetAttribute" + }, + "traits": { + "smithy.api#documentation": "The fleet attributes.
" + } + }, + "com.amazonaws.appstream#FleetError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.appstream#FleetErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a fleet error.
" + } + }, + "com.amazonaws.appstream#FleetErrorCode": { + "type": "enum", + "members": { + "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION" + } + }, + "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION" + } + }, + "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION" + } + }, + "NETWORK_INTERFACE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_INTERFACE_LIMIT_EXCEEDED" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + }, + "IAM_SERVICE_ROLE_IS_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_IS_MISSING" + } + }, + "MACHINE_ROLE_IS_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MACHINE_ROLE_IS_MISSING" + } + }, + "STS_DISABLED_IN_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STS_DISABLED_IN_REGION" + } + }, + "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES" + } + }, + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION" + } + }, + "SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_NOT_FOUND" + } + }, + "IMAGE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_NOT_FOUND" + } + }, + "INVALID_SUBNET_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SUBNET_CONFIGURATION" + } + }, + "SECURITY_GROUPS_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURITY_GROUPS_NOT_FOUND" + } + }, + "IGW_NOT_ATTACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGW_NOT_ATTACHED" + } + }, + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION" + } + }, + "FLEET_STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_STOPPED" + } + }, + "FLEET_INSTANCE_PROVISIONING_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLEET_INSTANCE_PROVISIONING_FAILURE" + } + }, + "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND" + } + }, + "DOMAIN_JOIN_ERROR_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_ACCESS_DENIED" + } + }, + "DOMAIN_JOIN_ERROR_LOGON_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_LOGON_FAILURE" + } + }, + "DOMAIN_JOIN_ERROR_INVALID_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_INVALID_PARAMETER" + } + }, + "DOMAIN_JOIN_ERROR_MORE_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_MORE_DATA" + } + }, + "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN" + } + }, + "DOMAIN_JOIN_ERROR_NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_NOT_SUPPORTED" + } + }, + "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME" + } + }, + "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED" + } + }, + "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED" + } + }, + "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED" + } + }, + "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR" + } + } + } + }, + "com.amazonaws.appstream#FleetErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#FleetError" + } + }, + "com.amazonaws.appstream#FleetList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Fleet" + }, + "traits": { + "smithy.api#documentation": "The fleets.
" + } + }, + "com.amazonaws.appstream#FleetState": { + "type": "enum", + "members": { + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.appstream#FleetType": { + "type": "enum", + "members": { + "ALWAYS_ON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALWAYS_ON" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "ELASTIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELASTIC" + } + } + } + }, + "com.amazonaws.appstream#Image": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the image.
" + } + }, + "BaseImageArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the image from which this image was created.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The image name to display.
" + } + }, + "State": { + "target": "com.amazonaws.appstream#ImageState", + "traits": { + "smithy.api#documentation": "The image starts in the PENDING state. If image creation succeeds, the\n state is AVAILABLE. If image creation fails, the state is FAILED.
Indicates whether the image is public or private.
" + } + }, + "ImageBuilderSupported": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether an image builder can be launched from this image.
" + } + }, + "ImageBuilderName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the image builder that was used to create the private image. If the image is shared, this value is null.
" + } + }, + "Platform": { + "target": "com.amazonaws.appstream#PlatformType", + "traits": { + "smithy.api#documentation": "The operating system platform of the image.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "StateChangeReason": { + "target": "com.amazonaws.appstream#ImageStateChangeReason", + "traits": { + "smithy.api#documentation": "The reason why the last state change occurred.
" + } + }, + "Applications": { + "target": "com.amazonaws.appstream#Applications", + "traits": { + "smithy.api#documentation": "The applications associated with the image.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time the image was created.
" + } + }, + "PublicBaseImageReleasedDate": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The release date of the public base image. \n For private images, this date is the release date of the base image from which the image was created.
" + } + }, + "AppstreamAgentVersion": { + "target": "com.amazonaws.appstream#AppstreamAgentVersion", + "traits": { + "smithy.api#documentation": "The version of the AppStream 2.0 agent to use for instances that are launched from this image.
" + } + }, + "ImagePermissions": { + "target": "com.amazonaws.appstream#ImagePermissions", + "traits": { + "smithy.api#documentation": "The permissions to provide to the destination AWS account for the specified image.
" + } + }, + "ImageErrors": { + "target": "com.amazonaws.appstream#ResourceErrors", + "traits": { + "smithy.api#documentation": "Describes the errors that are returned when a new image can't be created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an image.
" + } + }, + "com.amazonaws.appstream#ImageBuilder": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image builder.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN for the image builder.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the image from which this builder was created.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The image builder name to display.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration of the image builder.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The instance type for the image builder. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe operating system platform of the image builder.
" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "State": { + "target": "com.amazonaws.appstream#ImageBuilderState", + "traits": { + "smithy.api#documentation": "The state of the image builder.
" + } + }, + "StateChangeReason": { + "target": "com.amazonaws.appstream#ImageBuilderStateChangeReason", + "traits": { + "smithy.api#documentation": "The reason why the last state change occurred.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time stamp when the image builder was created.
" + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Enables or disables default internet access for the image builder.
" + } + }, + "DomainJoinInfo": { + "target": "com.amazonaws.appstream#DomainJoinInfo", + "traits": { + "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
" + } + }, + "NetworkAccessConfiguration": { + "target": "com.amazonaws.appstream#NetworkAccessConfiguration" + }, + "ImageBuilderErrors": { + "target": "com.amazonaws.appstream#ResourceErrors", + "traits": { + "smithy.api#documentation": "The image builder errors.
" + } + }, + "AppstreamAgentVersion": { + "target": "com.amazonaws.appstream#AppstreamAgentVersion", + "traits": { + "smithy.api#documentation": "The version of the AppStream 2.0 agent that is currently being used by the image builder.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a virtual machine that is used to create an image.
" + } + }, + "com.amazonaws.appstream#ImageBuilderList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#ImageBuilder" + } + }, + "com.amazonaws.appstream#ImageBuilderState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "UPDATING_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING_AGENT" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "REBOOTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REBOOTING" + } + }, + "SNAPSHOTTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNAPSHOTTING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING_QUALIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_QUALIFICATION" + } + } + } + }, + "com.amazonaws.appstream#ImageBuilderStateChangeReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.appstream#ImageBuilderStateChangeReasonCode", + "traits": { + "smithy.api#documentation": "The state change reason code.
" + } + }, + "Message": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The state change reason message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the reason why the last image builder state change occurred.
" + } + }, + "com.amazonaws.appstream#ImageBuilderStateChangeReasonCode": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "IMAGE_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_UNAVAILABLE" + } + } + } }, - { - "target": "com.amazonaws.appstream#AssociateApplicationFleet" + "com.amazonaws.appstream#ImageList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Image" + } }, - { - "target": "com.amazonaws.appstream#AssociateApplicationToEntitlement" + "com.amazonaws.appstream#ImagePermissions": { + "type": "structure", + "members": { + "allowFleet": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Indicates whether the image can be used for a fleet.
" + } + }, + "allowImageBuilder": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Indicates whether the image can be used for an image builder.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the permissions for an image.
" + } }, - { - "target": "com.amazonaws.appstream#AssociateFleet" + "com.amazonaws.appstream#ImageState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COPYING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPYING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "IMPORTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORTING" + } + } + } }, - { - "target": "com.amazonaws.appstream#BatchAssociateUserStack" + "com.amazonaws.appstream#ImageStateChangeReason": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.appstream#ImageStateChangeReasonCode", + "traits": { + "smithy.api#documentation": "The state change reason code.
" + } + }, + "Message": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The state change reason message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the reason why the last image state change occurred.
" + } }, - { - "target": "com.amazonaws.appstream#BatchDisassociateUserStack" + "com.amazonaws.appstream#ImageStateChangeReasonCode": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "IMAGE_BUILDER_NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_BUILDER_NOT_AVAILABLE" + } + }, + "IMAGE_COPY_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_COPY_FAILURE" + } + } + } }, - { - "target": "com.amazonaws.appstream#CopyImage" + "com.amazonaws.appstream#IncompatibleImageException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The image can't be updated because it's not compatible for updates.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#CreateAppBlock" + "com.amazonaws.appstream#Integer": { + "type": "integer" }, - { - "target": "com.amazonaws.appstream#CreateAppBlockBuilder" + "com.amazonaws.appstream#InvalidAccountStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURL" + "com.amazonaws.appstream#InvalidParameterCombinationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Indicates an incorrect combination of parameters, or a missing parameter.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#CreateApplication" + "com.amazonaws.appstream#InvalidRoleException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified role is invalid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#CreateDirectoryConfig" + "com.amazonaws.appstream#LastReportGenerationExecutionError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.appstream#UsageReportExecutionErrorCode", + "traits": { + "smithy.api#documentation": "The error code for the error that is returned when a usage report can't be generated.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The error message for the error that is returned when a usage report can't be generated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the error that is returned when a usage report can't be generated.
" + } }, - { - "target": "com.amazonaws.appstream#CreateEntitlement" + "com.amazonaws.appstream#LastReportGenerationExecutionErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#LastReportGenerationExecutionError" + } }, - { - "target": "com.amazonaws.appstream#CreateFleet" + "com.amazonaws.appstream#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The requested limit exceeds the permitted limit for an account.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#CreateImageBuilder" + "com.amazonaws.appstream#ListAssociatedFleets": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#ListAssociatedFleetsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#ListAssociatedFleetsResult" + }, + "traits": { + "smithy.api#documentation": "Retrieves the name of the fleet that is associated with the specified stack.
" + } }, - { - "target": "com.amazonaws.appstream#CreateImageBuilderStreamingURL" + "com.amazonaws.appstream#ListAssociatedFleetsRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.appstream#CreateStack" + "com.amazonaws.appstream#ListAssociatedFleetsResult": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The name of the fleet.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#CreateStreamingURL" + "com.amazonaws.appstream#ListAssociatedStacks": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#ListAssociatedStacksRequest" + }, + "output": { + "target": "com.amazonaws.appstream#ListAssociatedStacksResult" + }, + "traits": { + "smithy.api#documentation": "Retrieves the name of the stack with which the specified fleet is associated.
" + } }, - { - "target": "com.amazonaws.appstream#CreateUpdatedImage" + "com.amazonaws.appstream#ListAssociatedStacksRequest": { + "type": "structure", + "members": { + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.appstream#CreateUsageReportSubscription" + "com.amazonaws.appstream#ListAssociatedStacksResult": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.appstream#StringList", + "traits": { + "smithy.api#documentation": "The name of the stack.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#CreateUser" + "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.
" + } }, - { - "target": "com.amazonaws.appstream#DeleteAppBlock" + "com.amazonaws.appstream#ListEntitledApplicationsRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "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#clientOptional": {}, + "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.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.appstream#DeleteAppBlockBuilder" + "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.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#DeleteApplication" + "com.amazonaws.appstream#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.appstream#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } }, - { - "target": "com.amazonaws.appstream#DeleteDirectoryConfig" + "com.amazonaws.appstream#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.appstream#DeleteEntitlement" + "com.amazonaws.appstream#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#documentation": "The information about the tags.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#DeleteFleet" + "com.amazonaws.appstream#Long": { + "type": "long" }, - { - "target": "com.amazonaws.appstream#DeleteImage" + "com.amazonaws.appstream#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 500 + } + } }, - { - "target": "com.amazonaws.appstream#DeleteImageBuilder" + "com.amazonaws.appstream#MessageAction": { + "type": "enum", + "members": { + "SUPPRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUPPRESS" + } + }, + "RESEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESEND" + } + } + } }, - { - "target": "com.amazonaws.appstream#DeleteImagePermissions" + "com.amazonaws.appstream#Metadata": { + "type": "map", + "key": { + "target": "com.amazonaws.appstream#String" + }, + "value": { + "target": "com.amazonaws.appstream#String" + } }, - { - "target": "com.amazonaws.appstream#DeleteStack" + "com.amazonaws.appstream#Name": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$" + } }, - { - "target": "com.amazonaws.appstream#DeleteUsageReportSubscription" + "com.amazonaws.appstream#NetworkAccessConfiguration": { + "type": "structure", + "members": { + "EniPrivateIpAddress": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The private IP address of the elastic network interface that is attached to instances in your VPC.
" + } + }, + "EniId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the network details of the fleet or image builder instance.
" + } }, - { - "target": "com.amazonaws.appstream#DeleteUser" + "com.amazonaws.appstream#OperationNotPermittedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The attempted operation is not permitted.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociations" + "com.amazonaws.appstream#OrganizationalUnitDistinguishedName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } }, - { - "target": "com.amazonaws.appstream#DescribeAppBlockBuilders" + "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedName" + } }, - { - "target": "com.amazonaws.appstream#DescribeAppBlocks" + "com.amazonaws.appstream#PackagingType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "APPSTREAM2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APPSTREAM2" + } + } + } }, - { - "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociations" + "com.amazonaws.appstream#Permission": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } }, - { - "target": "com.amazonaws.appstream#DescribeApplications" + "com.amazonaws.appstream#PhotonAdminProxyService": { + "type": "service", + "version": "2016-12-01", + "operations": [ + { + "target": "com.amazonaws.appstream#AssociateAppBlockBuilderAppBlock" + }, + { + "target": "com.amazonaws.appstream#AssociateApplicationFleet" + }, + { + "target": "com.amazonaws.appstream#AssociateApplicationToEntitlement" + }, + { + "target": "com.amazonaws.appstream#AssociateFleet" + }, + { + "target": "com.amazonaws.appstream#BatchAssociateUserStack" + }, + { + "target": "com.amazonaws.appstream#BatchDisassociateUserStack" + }, + { + "target": "com.amazonaws.appstream#CopyImage" + }, + { + "target": "com.amazonaws.appstream#CreateAppBlock" + }, + { + "target": "com.amazonaws.appstream#CreateAppBlockBuilder" + }, + { + "target": "com.amazonaws.appstream#CreateAppBlockBuilderStreamingURL" + }, + { + "target": "com.amazonaws.appstream#CreateApplication" + }, + { + "target": "com.amazonaws.appstream#CreateDirectoryConfig" + }, + { + "target": "com.amazonaws.appstream#CreateEntitlement" + }, + { + "target": "com.amazonaws.appstream#CreateFleet" + }, + { + "target": "com.amazonaws.appstream#CreateImageBuilder" + }, + { + "target": "com.amazonaws.appstream#CreateImageBuilderStreamingURL" + }, + { + "target": "com.amazonaws.appstream#CreateStack" + }, + { + "target": "com.amazonaws.appstream#CreateStreamingURL" + }, + { + "target": "com.amazonaws.appstream#CreateUpdatedImage" + }, + { + "target": "com.amazonaws.appstream#CreateUsageReportSubscription" + }, + { + "target": "com.amazonaws.appstream#CreateUser" + }, + { + "target": "com.amazonaws.appstream#DeleteAppBlock" + }, + { + "target": "com.amazonaws.appstream#DeleteAppBlockBuilder" + }, + { + "target": "com.amazonaws.appstream#DeleteApplication" + }, + { + "target": "com.amazonaws.appstream#DeleteDirectoryConfig" + }, + { + "target": "com.amazonaws.appstream#DeleteEntitlement" + }, + { + "target": "com.amazonaws.appstream#DeleteFleet" + }, + { + "target": "com.amazonaws.appstream#DeleteImage" + }, + { + "target": "com.amazonaws.appstream#DeleteImageBuilder" + }, + { + "target": "com.amazonaws.appstream#DeleteImagePermissions" + }, + { + "target": "com.amazonaws.appstream#DeleteStack" + }, + { + "target": "com.amazonaws.appstream#DeleteUsageReportSubscription" + }, + { + "target": "com.amazonaws.appstream#DeleteUser" + }, + { + "target": "com.amazonaws.appstream#DescribeAppBlockBuilderAppBlockAssociations" + }, + { + "target": "com.amazonaws.appstream#DescribeAppBlockBuilders" + }, + { + "target": "com.amazonaws.appstream#DescribeAppBlocks" + }, + { + "target": "com.amazonaws.appstream#DescribeApplicationFleetAssociations" + }, + { + "target": "com.amazonaws.appstream#DescribeApplications" + }, + { + "target": "com.amazonaws.appstream#DescribeDirectoryConfigs" + }, + { + "target": "com.amazonaws.appstream#DescribeEntitlements" + }, + { + "target": "com.amazonaws.appstream#DescribeFleets" + }, + { + "target": "com.amazonaws.appstream#DescribeImageBuilders" + }, + { + "target": "com.amazonaws.appstream#DescribeImagePermissions" + }, + { + "target": "com.amazonaws.appstream#DescribeImages" + }, + { + "target": "com.amazonaws.appstream#DescribeSessions" + }, + { + "target": "com.amazonaws.appstream#DescribeStacks" + }, + { + "target": "com.amazonaws.appstream#DescribeUsageReportSubscriptions" + }, + { + "target": "com.amazonaws.appstream#DescribeUsers" + }, + { + "target": "com.amazonaws.appstream#DescribeUserStackAssociations" + }, + { + "target": "com.amazonaws.appstream#DisableUser" + }, + { + "target": "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlock" + }, + { + "target": "com.amazonaws.appstream#DisassociateApplicationFleet" + }, + { + "target": "com.amazonaws.appstream#DisassociateApplicationFromEntitlement" + }, + { + "target": "com.amazonaws.appstream#DisassociateFleet" + }, + { + "target": "com.amazonaws.appstream#EnableUser" + }, + { + "target": "com.amazonaws.appstream#ExpireSession" + }, + { + "target": "com.amazonaws.appstream#ListAssociatedFleets" + }, + { + "target": "com.amazonaws.appstream#ListAssociatedStacks" + }, + { + "target": "com.amazonaws.appstream#ListEntitledApplications" + }, + { + "target": "com.amazonaws.appstream#ListTagsForResource" + }, + { + "target": "com.amazonaws.appstream#StartAppBlockBuilder" + }, + { + "target": "com.amazonaws.appstream#StartFleet" + }, + { + "target": "com.amazonaws.appstream#StartImageBuilder" + }, + { + "target": "com.amazonaws.appstream#StopAppBlockBuilder" + }, + { + "target": "com.amazonaws.appstream#StopFleet" + }, + { + "target": "com.amazonaws.appstream#StopImageBuilder" + }, + { + "target": "com.amazonaws.appstream#TagResource" + }, + { + "target": "com.amazonaws.appstream#UntagResource" + }, + { + "target": "com.amazonaws.appstream#UpdateAppBlockBuilder" + }, + { + "target": "com.amazonaws.appstream#UpdateApplication" + }, + { + "target": "com.amazonaws.appstream#UpdateDirectoryConfig" + }, + { + "target": "com.amazonaws.appstream#UpdateEntitlement" + }, + { + "target": "com.amazonaws.appstream#UpdateFleet" + }, + { + "target": "com.amazonaws.appstream#UpdateImagePermissions" + }, + { + "target": "com.amazonaws.appstream#UpdateStack" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "AppStream", + "arnNamespace": "appstream", + "cloudFormationName": "AppStream", + "cloudTrailEventSource": "appstream.amazonaws.com", + "endpointPrefix": "appstream2" + }, + "aws.auth#sigv4": { + "name": "appstream" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
\nYou can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
\nTo learn more about AppStream 2.0, see the following resources:
\nAppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#DescribeSessions" + "com.amazonaws.appstream#ResourceAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#DescribeStacks" + "com.amazonaws.appstream#ResourceError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.appstream#FleetErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The error message.
" + } + }, + "ErrorTimestamp": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time the error occurred.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a resource error.
" + } }, - { - "target": "com.amazonaws.appstream#DescribeUsageReportSubscriptions" + "com.amazonaws.appstream#ResourceErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#ResourceError" + } }, - { - "target": "com.amazonaws.appstream#DescribeUsers" + "com.amazonaws.appstream#ResourceIdentifier": { + "type": "string", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } }, - { - "target": "com.amazonaws.appstream#DescribeUserStackAssociations" + "com.amazonaws.appstream#ResourceInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource is in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#DisableUser" + "com.amazonaws.appstream#ResourceNotAvailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource exists and is not in use, but isn't available.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.appstream#DisassociateAppBlockBuilderAppBlock" + "com.amazonaws.appstream#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } }, - { - "target": "com.amazonaws.appstream#DisassociateApplicationFleet" + "com.amazonaws.appstream#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[0-9a-z\\.\\-]*(?The S3 bucket of the S3 object.", + "smithy.api#required": {} + } + }, + "S3Key": { + "target": "com.amazonaws.appstream#S3Key", + "traits": { + "smithy.api#documentation": "The S3 key of the S3 object.
\nThis is required when used for the following:
\nIconS3Location (Actions: CreateApplication and UpdateApplication)
\nSessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
\nScriptDetails (Actions: CreateAppBlock)
\nSourceS3Location when creating an app block with CUSTOM PackagingType (Actions:\n CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and\n using an existing application package (VHD file). In this case,\n S3Key refers to the VHD file. If a new application package is\n required, then S3Key is not required. (Actions:\n CreateAppBlock)
Describes the S3 location.
" + } }, - { - "target": "com.amazonaws.appstream#EnableUser" + "com.amazonaws.appstream#ScriptDetails": { + "type": "structure", + "members": { + "ScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The S3 object location for the script.
", + "smithy.api#required": {} + } + }, + "ExecutablePath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The run path for the script.
", + "smithy.api#required": {} + } + }, + "ExecutableParameters": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The runtime parameters passed to the run path for the script.
" + } + }, + "TimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The run timeout, in seconds, for the script.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the details of the script.
" + } }, - { - "target": "com.amazonaws.appstream#ExpireSession" + "com.amazonaws.appstream#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#String" + }, + "traits": { + "smithy.api#documentation": "The security group identifiers.
", + "smithy.api#length": { + "min": 0, + "max": 5 + } + } }, - { - "target": "com.amazonaws.appstream#ListAssociatedFleets" + "com.amazonaws.appstream#ServiceAccountCredentials": { + "type": "structure", + "members": { + "AccountName": { + "target": "com.amazonaws.appstream#AccountName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user name of the account. This account must have the following privileges: create computer objects, \n join computers to the domain, and change/reset the password on descendant computer objects for the \n organizational units specified.
", + "smithy.api#required": {} + } + }, + "AccountPassword": { + "target": "com.amazonaws.appstream#AccountPassword", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The password for the account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the credentials for the service account used by the fleet or image builder to connect to the directory.
" + } }, - { - "target": "com.amazonaws.appstream#ListAssociatedStacks" + "com.amazonaws.appstream#Session": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier of the streaming session.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.appstream#UserId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The identifier of the user for whom the session was created.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack for the streaming session.
", + "smithy.api#required": {} + } + }, + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet for the streaming session.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.appstream#SessionState", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current state of the streaming session.
", + "smithy.api#required": {} + } + }, + "ConnectionState": { + "target": "com.amazonaws.appstream#SessionConnectionState", + "traits": { + "smithy.api#documentation": "Specifies whether a user is connected to the streaming session.
" + } + }, + "StartTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a streaming instance is dedicated for the user.
" + } + }, + "MaxExpirationTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
The authentication method. The user is authenticated using a streaming URL\n (API) or SAML 2.0 federation (SAML).
The network details for the streaming session.
" + } + }, + "InstanceId": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The identifier for the instance hosting the session.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a streaming session.
" + } }, - { - "target": "com.amazonaws.appstream#ListEntitledApplications" + "com.amazonaws.appstream#SessionConnectionState": { + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED" + } + }, + "NOT_CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONNECTED" + } + } + } }, - { - "target": "com.amazonaws.appstream#ListTagsForResource" + "com.amazonaws.appstream#SessionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Session" + }, + "traits": { + "smithy.api#documentation": "List of sessions.
" + } }, - { - "target": "com.amazonaws.appstream#StartAppBlockBuilder" + "com.amazonaws.appstream#SessionState": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + } + }, + "traits": { + "smithy.api#documentation": "Possible values for the state of a streaming session.
" + } }, - { - "target": "com.amazonaws.appstream#StartFleet" + "com.amazonaws.appstream#SettingsGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } }, - { - "target": "com.amazonaws.appstream#StartImageBuilder" + "com.amazonaws.appstream#SharedImagePermissions": { + "type": "structure", + "members": { + "sharedAccountId": { + "target": "com.amazonaws.appstream#AwsAccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The 12-digit identifier of the AWS account with which the image is shared.
", + "smithy.api#required": {} + } + }, + "imagePermissions": { + "target": "com.amazonaws.appstream#ImagePermissions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes the permissions for a shared image.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the permissions that are available to the specified AWS account for a shared image.
" + } }, - { - "target": "com.amazonaws.appstream#StopAppBlockBuilder" + "com.amazonaws.appstream#SharedImagePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#SharedImagePermissions" + } }, - { - "target": "com.amazonaws.appstream#StopFleet" + "com.amazonaws.appstream#Stack": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the stack.
" + } + }, + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The stack name to display.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time the stack was created.
" + } + }, + "StorageConnectors": { + "target": "com.amazonaws.appstream#StorageConnectorList", + "traits": { + "smithy.api#documentation": "The storage connectors to enable.
" + } + }, + "RedirectURL": { + "target": "com.amazonaws.appstream#RedirectURL", + "traits": { + "smithy.api#documentation": "The URL that users are redirected to after their streaming session ends.
" + } + }, + "FeedbackURL": { + "target": "com.amazonaws.appstream#FeedbackURL", + "traits": { + "smithy.api#documentation": "The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
" + } + }, + "StackErrors": { + "target": "com.amazonaws.appstream#StackErrors", + "traits": { + "smithy.api#documentation": "The errors for the stack.
" + } + }, + "UserSettings": { + "target": "com.amazonaws.appstream#UserSettingList", + "traits": { + "smithy.api#documentation": "The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
" + } + }, + "ApplicationSettings": { + "target": "com.amazonaws.appstream#ApplicationSettingsResponse", + "traits": { + "smithy.api#documentation": "The persistent application settings for users of the stack.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
" + } + }, + "EmbedHostDomains": { + "target": "com.amazonaws.appstream#EmbedHostDomains", + "traits": { + "smithy.api#documentation": "The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
" + } + }, + "StreamingExperienceSettings": { + "target": "com.amazonaws.appstream#StreamingExperienceSettings", + "traits": { + "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a stack.
" + } }, - { - "target": "com.amazonaws.appstream#StopImageBuilder" + "com.amazonaws.appstream#StackAttribute": { + "type": "enum", + "members": { + "STORAGE_CONNECTORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_CONNECTORS" + } + }, + "STORAGE_CONNECTOR_HOMEFOLDERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_CONNECTOR_HOMEFOLDERS" + } + }, + "STORAGE_CONNECTOR_GOOGLE_DRIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_CONNECTOR_GOOGLE_DRIVE" + } + }, + "STORAGE_CONNECTOR_ONE_DRIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_CONNECTOR_ONE_DRIVE" + } + }, + "REDIRECT_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDIRECT_URL" + } + }, + "FEEDBACK_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FEEDBACK_URL" + } + }, + "THEME_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THEME_NAME" + } + }, + "USER_SETTINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_SETTINGS" + } + }, + "EMBED_HOST_DOMAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMBED_HOST_DOMAINS" + } + }, + "IAM_ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE_ARN" + } + }, + "ACCESS_ENDPOINTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_ENDPOINTS" + } + }, + "STREAMING_EXPERIENCE_SETTINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREAMING_EXPERIENCE_SETTINGS" + } + } + } }, - { - "target": "com.amazonaws.appstream#TagResource" + "com.amazonaws.appstream#StackAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#StackAttribute" + } }, - { - "target": "com.amazonaws.appstream#UntagResource" + "com.amazonaws.appstream#StackError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.appstream#StackErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a stack error.
" + } }, - { - "target": "com.amazonaws.appstream#UpdateAppBlockBuilder" + "com.amazonaws.appstream#StackErrorCode": { + "type": "enum", + "members": { + "STORAGE_CONNECTOR_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STORAGE_CONNECTOR_ERROR" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + } + } }, - { - "target": "com.amazonaws.appstream#UpdateApplication" + "com.amazonaws.appstream#StackErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#StackError" + }, + "traits": { + "smithy.api#documentation": "The stack errors.
" + } }, - { - "target": "com.amazonaws.appstream#UpdateDirectoryConfig" + "com.amazonaws.appstream#StackList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Stack" + }, + "traits": { + "smithy.api#documentation": "The stacks.
" + } }, - { - "target": "com.amazonaws.appstream#UpdateEntitlement" + "com.amazonaws.appstream#StartAppBlockBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#StartAppBlockBuilderRequest" + }, + "output": { + "target": "com.amazonaws.appstream#StartAppBlockBuilderResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Starts an app block builder.
\nAn app block builder can only be started when it's associated with an app\n block.
\nStarting an app block builder starts a new instance, which is equivalent to an elastic\n fleet instance with application builder assistance functionality.
" + } }, - { - "target": "com.amazonaws.appstream#UpdateFleet" + "com.amazonaws.appstream#StartAppBlockBuilderRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.appstream#UpdateImagePermissions" + "com.amazonaws.appstream#StartAppBlockBuilderResult": { + "type": "structure", + "members": { + "AppBlockBuilder": { + "target": "com.amazonaws.appstream#AppBlockBuilder" + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#UpdateStack" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "AppStream", - "arnNamespace": "appstream", - "cloudFormationName": "AppStream", - "cloudTrailEventSource": "appstream.amazonaws.com", - "endpointPrefix": "appstream2" - }, - "aws.auth#sigv4": { - "name": "appstream" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.
\nYou can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.
\nTo learn more about AppStream 2.0, see the following resources:
\nStarts the specified fleet.
" + } + }, + "com.amazonaws.appstream#StartFleetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} } - ] } - ], - "rules": [ + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#StartFleetResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#StartImageBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#StartImageBuilderRequest" + }, + "output": { + "target": "com.amazonaws.appstream#StartImageBuilderResult" + }, + "errors": [ { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://appstream2.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://appstream2.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://appstream2.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Starts the specified image builder.
" + } + }, + "com.amazonaws.appstream#StartImageBuilderRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image builder.
", + "smithy.api#required": {} + } + }, + "AppstreamAgentVersion": { + "target": "com.amazonaws.appstream#AppstreamAgentVersion", + "traits": { + "smithy.api#documentation": "The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
" } - ], - "type": "tree" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "traits": { + "smithy.api#input": {} } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } + "com.amazonaws.appstream#StartImageBuilderResult": { + "type": "structure", + "members": { + "ImageBuilder": { + "target": "com.amazonaws.appstream#ImageBuilder", + "traits": { + "smithy.api#documentation": "Information about the image builder.
" + } + } }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#StopAppBlockBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#StopAppBlockBuilderRequest" }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.appstream#StopAppBlockBuilderResult" }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an app block builder.
\nStopping an app block builder terminates the instance, and the instance state is not\n persisted.
" + } + }, + "com.amazonaws.appstream#StopAppBlockBuilderRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the app block builder.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#StopAppBlockBuilderResult": { + "type": "structure", + "members": { + "AppBlockBuilder": { + "target": "com.amazonaws.appstream#AppBlockBuilder" + } }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#StopFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#StopFleetRequest" }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.appstream#StopFleetResult" }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Stops the specified fleet.
" + } + }, + "com.amazonaws.appstream#StopFleetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#StopFleetResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#StopImageBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#StopImageBuilderRequest" }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.appstream#StopImageBuilderResult" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Stops the specified image builder.
" + } + }, + "com.amazonaws.appstream#StopImageBuilderRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the image builder.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#StopImageBuilderResult": { + "type": "structure", + "members": { + "ImageBuilder": { + "target": "com.amazonaws.appstream#ImageBuilder", + "traits": { + "smithy.api#documentation": "Information about the image builder.
" + } + } }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#StorageConnector": { + "type": "structure", + "members": { + "ConnectorType": { + "target": "com.amazonaws.appstream#StorageConnectorType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of storage connector.
", + "smithy.api#required": {} + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.appstream#ResourceIdentifier", + "traits": { + "smithy.api#documentation": "The ARN of the storage connector.
" + } + }, + "Domains": { + "target": "com.amazonaws.appstream#DomainList", + "traits": { + "smithy.api#documentation": "The names of the domains for the account.
" + } + } }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "Describes a connector that enables persistent storage for users.
" + } + }, + "com.amazonaws.appstream#StorageConnectorList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#StorageConnector" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "The storage connectors.
" + } + }, + "com.amazonaws.appstream#StorageConnectorType": { + "type": "enum", + "members": { + "HOMEFOLDERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOMEFOLDERS" + } + }, + "GOOGLE_DRIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GOOGLE_DRIVE" + } + }, + "ONE_DRIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_DRIVE" + } + } }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "The type of storage connector.
" + } + }, + "com.amazonaws.appstream#StreamView": { + "type": "enum", + "members": { + "APP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "APP" + } + }, + "DESKTOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESKTOP" + } + } + } + }, + "com.amazonaws.appstream#StreamingExperienceSettings": { + "type": "structure", + "members": { + "PreferredProtocol": { + "target": "com.amazonaws.appstream#PreferredProtocol", + "traits": { + "smithy.api#documentation": "The preferred protocol that you want to use while streaming your application.
" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" + } + }, + "com.amazonaws.appstream#StreamingUrlUserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 32 + }, + "smithy.api#pattern": "^[\\w+=,.@-]*$" + } + }, + "com.amazonaws.appstream#String": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.appstream#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#String" + } + }, + "com.amazonaws.appstream#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#String" }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "The subnet identifiers.
" + } + }, + "com.amazonaws.appstream#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(^(?!aws:).[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.appstream#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#TagKey" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appstream2.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.appstream#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#TagResourceRequest" }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.appstream#TagResourceResponse" }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.
\nEach tag consists of a key and an optional value. If a resource already has a tag with the same key, \n this operation updates its value.
\nTo list the current tags for your resources, use ListTagsForResource.\n To disassociate tags from your resources, use UntagResource.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "com.amazonaws.appstream#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, + "com.amazonaws.appstream#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.appstream#TagKey" }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "value": { + "target": "com.amazonaws.appstream#TagValue" }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.appstream#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.appstream#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UntagResourceRequest" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.appstream#UntagResourceResponse" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates one or more specified tags from the specified AppStream 2.0 resource.
\nTo list the current tags for your resources, use ListTagsForResource.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "com.amazonaws.appstream#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.appstream#TagKeyList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The tag keys for the tags to disassociate.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#UpdateAppBlockBuilder": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateAppBlockBuilderRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.appstream#UpdateAppBlockBuilderResult" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an app block builder.
\nIf the app block builder is in the STARTING or STOPPING\n state, you can't update it. If the app block builder is in the RUNNING\n state, you can only update the DisplayName and Description. If the app block builder is\n in the STOPPED state, you can update any attribute except the Name.
The unique name for the app block builder.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the app block builder.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the app block builder.
" + } + }, + "Platform": { + "target": "com.amazonaws.appstream#PlatformType", + "traits": { + "smithy.api#documentation": "The platform of the app block builder.
\n\n WINDOWS_SERVER_2019 is the only valid value.
The instance type to use when launching the app block builder. The following instance\n types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe VPC configuration for the app block builder.
\nApp block builders require that you specify at least two subnets in different availability\n zones.
" + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Enables or disables default internet access for the app block builder.
" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To\n assume a role, the app block builder calls the AWS Security Token Service (STS)\n AssumeRole API operation and passes the ARN of the role to use. The\n operation creates a new session with temporary credentials. AppStream 2.0 retrieves the\n temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
" + } + }, + "AttributesToDelete": { + "target": "com.amazonaws.appstream#AppBlockBuilderAttributes", + "traits": { + "smithy.api#documentation": "The attributes to delete from the app block builder.
" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#UpdateAppBlockBuilderResult": { + "type": "structure", + "members": { + "AppBlockBuilder": { + "target": "com.amazonaws.appstream#AppBlockBuilder" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.appstream#UpdateApplicationResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified application.
" + } + }, + "com.amazonaws.appstream#UpdateApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the application. This name is visible to users when display name is not specified.
", + "smithy.api#required": {} + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The display name of the application. This name is visible to users in the application catalog.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the application.
" + } + }, + "IconS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The icon S3 location of the application.
" + } + }, + "LaunchPath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The launch path of the application.
" + } + }, + "WorkingDirectory": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The working directory of the application.
" + } + }, + "LaunchParameters": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The launch parameters of the application.
" + } + }, + "AppBlockArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the app block.
" + } + }, + "AttributesToDelete": { + "target": "com.amazonaws.appstream#ApplicationAttributes", + "traits": { + "smithy.api#documentation": "The attributes to delete for an application.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#UpdateApplicationResult": { + "type": "structure", + "members": { + "Application": { + "target": "com.amazonaws.appstream#Application" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#UpdateDirectoryConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateDirectoryConfigRequest" + }, + "output": { + "target": "com.amazonaws.appstream#UpdateDirectoryConfigResult" }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" + } + }, + "com.amazonaws.appstream#UpdateDirectoryConfigRequest": { + "type": "structure", + "members": { + "DirectoryName": { + "target": "com.amazonaws.appstream#DirectoryName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the Directory Config object.
", + "smithy.api#required": {} + } + }, + "OrganizationalUnitDistinguishedNames": { + "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", + "traits": { + "smithy.api#documentation": "The distinguished names of the organizational units for computer accounts.
" + } + }, + "ServiceAccountCredentials": { + "target": "com.amazonaws.appstream#ServiceAccountCredentials", + "traits": { + "smithy.api#documentation": "The credentials for the service account used by the fleet or image builder to connect to the directory.
" + } + }, + "CertificateBasedAuthProperties": { + "target": "com.amazonaws.appstream#CertificateBasedAuthProperties", + "traits": { + "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#UpdateDirectoryConfigResult": { + "type": "structure", + "members": { + "DirectoryConfig": { + "target": "com.amazonaws.appstream#DirectoryConfig", + "traits": { + "smithy.api#documentation": "Information about the Directory Config object.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#UpdateEntitlement": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateEntitlementRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://appstream2.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.appstream#UpdateEntitlementResult" }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "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#clientOptional": {}, + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "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.
" + } + } }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appstream#UpdateEntitlementResult": { + "type": "structure", + "members": { + "Entitlement": { + "target": "com.amazonaws.appstream#Entitlement", + "traits": { + "smithy.api#documentation": "The entitlement.
" + } + } }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.appstream#UpdateFleet": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateFleetRequest" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.appstream#UpdateFleetResult" }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#RequestLimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified fleet.
\nIf the fleet is in the STOPPED state, you can update any attribute except\n the fleet name.
If the fleet is in the RUNNING state, you can update the following based\n on the fleet type:
Always-On and On-Demand fleet types
\nYou can update the DisplayName, ComputeCapacity,\n ImageARN, ImageName,\n IdleDisconnectTimeoutInSeconds, and\n DisconnectTimeoutInSeconds attributes.
Elastic fleet type
\nYou can update the DisplayName,\n IdleDisconnectTimeoutInSeconds,\n DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location\n and UsbDeviceFilterStrings attributes.
If the fleet is in the STARTING or STOPPED state, you can't update it.
The name of the image used to create the fleet.
" + } + }, + "ImageArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the public, private, or shared image to use.
" + } + }, + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "A unique name for the fleet.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe following instance types are available for Elastic fleets:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe desired capacity for the fleet. This is not allowed for Elastic fleets.
" + } + }, + "VpcConfig": { + "target": "com.amazonaws.appstream#VpcConfig", + "traits": { + "smithy.api#documentation": "The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
" + } + }, + "MaxUserDurationInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
\nSpecify a value between 600 and 432000.
" + } + }, + "DisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
\nSpecify a value between 60 and 360000.
" + } + }, + "DeleteVpcConfig": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Deletes the VPC association for the specified fleet.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The fleet name to display.
" + } + }, + "EnableDefaultInternetAccess": { + "target": "com.amazonaws.appstream#BooleanObject", + "traits": { + "smithy.api#documentation": "Enables or disables default internet access for the fleet.
" + } + }, + "DomainJoinInfo": { + "target": "com.amazonaws.appstream#DomainJoinInfo", + "traits": { + "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
" + } + }, + "IdleDisconnectTimeoutInSeconds": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe fleet attributes to delete.
" + } + }, + "IamRoleArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" + } + }, + "StreamView": { + "target": "com.amazonaws.appstream#StreamView", + "traits": { + "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
" + } + }, + "MaxConcurrentSessions": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of concurrent sessions for a fleet.
" + } + }, + "UsbDeviceFilterStrings": { + "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", + "traits": { + "smithy.api#documentation": "The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
" + } + }, + "SessionScriptS3Location": { + "target": "com.amazonaws.appstream#S3Location", + "traits": { + "smithy.api#documentation": "The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
" + } + }, + "MaxSessionsPerInstance": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
" + } + } + }, + "traits": { + "smithy.api#input": {} } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.appstream#PlatformType": { - "type": "enum", - "members": { - "WINDOWS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS" - } - }, - "WINDOWS_SERVER_2016": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2016" - } - }, - "WINDOWS_SERVER_2019": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2019" - } - }, - "WINDOWS_SERVER_2022": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_SERVER_2022" - } - }, - "AMAZON_LINUX2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON_LINUX2" - } - } - } - }, - "com.amazonaws.appstream#Platforms": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#PlatformType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4 - } - } - }, - "com.amazonaws.appstream#PreferredProtocol": { - "type": "enum", - "members": { - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TCP" - } - }, - "UDP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UDP" - } - } - } - }, - "com.amazonaws.appstream#RedirectURL": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.appstream#RegionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.appstream#RequestLimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "AppStream 2.0 can’t process the request right now because the Describe calls from your AWS account are being throttled by Amazon EC2. Try again later.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource already exists.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#ResourceError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.appstream#FleetErrorCode", - "traits": { - "smithy.api#documentation": "The error code.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The error message.
" - } - }, - "ErrorTimestamp": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time the error occurred.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a resource error.
" - } - }, - "com.amazonaws.appstream#ResourceErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#ResourceError" - } - }, - "com.amazonaws.appstream#ResourceIdentifier": { - "type": "string", - "traits": { - "smithy.api#documentation": "The ARN of the resource.
", - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.appstream#ResourceInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource is in use.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#ResourceNotAvailableException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource exists and is not in use, but isn't available.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The specified resource was not found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.appstream#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[0-9a-z\\.\\-]*(?The S3 bucket of the S3 object.", - "smithy.api#required": {} - } - }, - "S3Key": { - "target": "com.amazonaws.appstream#S3Key", - "traits": { - "smithy.api#documentation": "The S3 key of the S3 object.
\nThis is required when used for the following:
\nIconS3Location (Actions: CreateApplication and UpdateApplication)
\nSessionScriptS3Location (Actions: CreateFleet and UpdateFleet)
\nScriptDetails (Actions: CreateAppBlock)
\nSourceS3Location when creating an app block with CUSTOM PackagingType (Actions:\n CreateAppBlock)
SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and\n using an existing application package (VHD file). In this case,\n S3Key refers to the VHD file. If a new application package is\n required, then S3Key is not required. (Actions:\n CreateAppBlock)
Describes the S3 location.
" - } - }, - "com.amazonaws.appstream#ScriptDetails": { - "type": "structure", - "members": { - "ScriptS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The S3 object location for the script.
", - "smithy.api#required": {} - } - }, - "ExecutablePath": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The run path for the script.
", - "smithy.api#required": {} - } - }, - "ExecutableParameters": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The runtime parameters passed to the run path for the script.
" - } - }, - "TimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The run timeout, in seconds, for the script.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the details of the script.
" - } - }, - "com.amazonaws.appstream#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#String" - }, - "traits": { - "smithy.api#documentation": "The security group identifiers.
", - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.appstream#ServiceAccountCredentials": { - "type": "structure", - "members": { - "AccountName": { - "target": "com.amazonaws.appstream#AccountName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user name of the account. This account must have the following privileges: create computer objects, \n join computers to the domain, and change/reset the password on descendant computer objects for the \n organizational units specified.
", - "smithy.api#required": {} - } - }, - "AccountPassword": { - "target": "com.amazonaws.appstream#AccountPassword", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The password for the account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the credentials for the service account used by the fleet or image builder to connect to the directory.
" - } - }, - "com.amazonaws.appstream#Session": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the streaming session.
", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.appstream#UserId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The identifier of the user for whom the session was created.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack for the streaming session.
", - "smithy.api#required": {} - } - }, - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet for the streaming session.
", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.appstream#SessionState", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current state of the streaming session.
", - "smithy.api#required": {} - } - }, - "ConnectionState": { - "target": "com.amazonaws.appstream#SessionConnectionState", - "traits": { - "smithy.api#documentation": "Specifies whether a user is connected to the streaming session.
" - } - }, - "StartTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time when a streaming instance is dedicated for the user.
" - } - }, - "MaxExpirationTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
The authentication method. The user is authenticated using a streaming URL\n (API) or SAML 2.0 federation (SAML).
The network details for the streaming session.
" - } - }, - "InstanceId": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The identifier for the instance hosting the session.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a streaming session.
" - } - }, - "com.amazonaws.appstream#SessionConnectionState": { - "type": "enum", - "members": { - "CONNECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTED" - } - }, - "NOT_CONNECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_CONNECTED" - } - } - } - }, - "com.amazonaws.appstream#SessionList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Session" - }, - "traits": { - "smithy.api#documentation": "List of sessions.
" - } - }, - "com.amazonaws.appstream#SessionState": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "EXPIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - } - }, - "traits": { - "smithy.api#documentation": "Possible values for the state of a streaming session.
" - } - }, - "com.amazonaws.appstream#SettingsGroup": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.appstream#SharedImagePermissions": { - "type": "structure", - "members": { - "sharedAccountId": { - "target": "com.amazonaws.appstream#AwsAccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The 12-digit identifier of the AWS account with which the image is shared.
", - "smithy.api#required": {} - } - }, - "imagePermissions": { - "target": "com.amazonaws.appstream#ImagePermissions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes the permissions for a shared image.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the permissions that are available to the specified AWS account for a shared image.
" - } - }, - "com.amazonaws.appstream#SharedImagePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#SharedImagePermissions" - } - }, - "com.amazonaws.appstream#Stack": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the stack.
" - } - }, - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The stack name to display.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time the stack was created.
" - } - }, - "StorageConnectors": { - "target": "com.amazonaws.appstream#StorageConnectorList", - "traits": { - "smithy.api#documentation": "The storage connectors to enable.
" - } - }, - "RedirectURL": { - "target": "com.amazonaws.appstream#RedirectURL", - "traits": { - "smithy.api#documentation": "The URL that users are redirected to after their streaming session ends.
" - } - }, - "FeedbackURL": { - "target": "com.amazonaws.appstream#FeedbackURL", - "traits": { - "smithy.api#documentation": "The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
" - } - }, - "StackErrors": { - "target": "com.amazonaws.appstream#StackErrors", - "traits": { - "smithy.api#documentation": "The errors for the stack.
" - } - }, - "UserSettings": { - "target": "com.amazonaws.appstream#UserSettingList", - "traits": { - "smithy.api#documentation": "The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
" - } - }, - "ApplicationSettings": { - "target": "com.amazonaws.appstream#ApplicationSettingsResponse", - "traits": { - "smithy.api#documentation": "The persistent application settings for users of the stack.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
" - } - }, - "EmbedHostDomains": { - "target": "com.amazonaws.appstream#EmbedHostDomains", - "traits": { - "smithy.api#documentation": "The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
" - } - }, - "StreamingExperienceSettings": { - "target": "com.amazonaws.appstream#StreamingExperienceSettings", - "traits": { - "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a stack.
" - } - }, - "com.amazonaws.appstream#StackAttribute": { - "type": "enum", - "members": { - "STORAGE_CONNECTORS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STORAGE_CONNECTORS" - } - }, - "STORAGE_CONNECTOR_HOMEFOLDERS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STORAGE_CONNECTOR_HOMEFOLDERS" - } - }, - "STORAGE_CONNECTOR_GOOGLE_DRIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STORAGE_CONNECTOR_GOOGLE_DRIVE" - } - }, - "STORAGE_CONNECTOR_ONE_DRIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STORAGE_CONNECTOR_ONE_DRIVE" - } - }, - "REDIRECT_URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDIRECT_URL" - } - }, - "FEEDBACK_URL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FEEDBACK_URL" - } - }, - "THEME_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THEME_NAME" - } - }, - "USER_SETTINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER_SETTINGS" - } - }, - "EMBED_HOST_DOMAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMBED_HOST_DOMAINS" - } - }, - "IAM_ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_ROLE_ARN" - } - }, - "ACCESS_ENDPOINTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_ENDPOINTS" - } - }, - "STREAMING_EXPERIENCE_SETTINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STREAMING_EXPERIENCE_SETTINGS" - } - } - } - }, - "com.amazonaws.appstream#StackAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#StackAttribute" - } - }, - "com.amazonaws.appstream#StackError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.appstream#StackErrorCode", - "traits": { - "smithy.api#documentation": "The error code.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The error message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a stack error.
" - } - }, - "com.amazonaws.appstream#StackErrorCode": { - "type": "enum", - "members": { - "STORAGE_CONNECTOR_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STORAGE_CONNECTOR_ERROR" - } - }, - "INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" - } - } - } - }, - "com.amazonaws.appstream#StackErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#StackError" - }, - "traits": { - "smithy.api#documentation": "The stack errors.
" - } - }, - "com.amazonaws.appstream#StackList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Stack" - }, - "traits": { - "smithy.api#documentation": "The stacks.
" - } - }, - "com.amazonaws.appstream#StartAppBlockBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#StartAppBlockBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#StartAppBlockBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#RequestLimitExceededException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Starts an app block builder.
\nAn app block builder can only be started when it's associated with an app\n block.
\nStarting an app block builder starts a new instance, which is equivalent to an elastic\n fleet instance with application builder assistance functionality.
" - } - }, - "com.amazonaws.appstream#StartAppBlockBuilderRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#StartAppBlockBuilderResult": { - "type": "structure", - "members": { - "AppBlockBuilder": { - "target": "com.amazonaws.appstream#AppBlockBuilder" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#StartFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#StartFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#StartFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#RequestLimitExceededException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Starts the specified fleet.
" - } - }, - "com.amazonaws.appstream#StartFleetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#StartFleetResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#StartImageBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#StartImageBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#StartImageBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#IncompatibleImageException" - }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Starts the specified image builder.
" - } - }, - "com.amazonaws.appstream#StartImageBuilderRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image builder.
", - "smithy.api#required": {} - } - }, - "AppstreamAgentVersion": { - "target": "com.amazonaws.appstream#AppstreamAgentVersion", - "traits": { - "smithy.api#documentation": "The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#StartImageBuilderResult": { - "type": "structure", - "members": { - "ImageBuilder": { - "target": "com.amazonaws.appstream#ImageBuilder", - "traits": { - "smithy.api#documentation": "Information about the image builder.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#StopAppBlockBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#StopAppBlockBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#StopAppBlockBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Stops an app block builder.
\nStopping an app block builder terminates the instance, and the instance state is not\n persisted.
" - } - }, - "com.amazonaws.appstream#StopAppBlockBuilderRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the app block builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#StopAppBlockBuilderResult": { - "type": "structure", - "members": { - "AppBlockBuilder": { - "target": "com.amazonaws.appstream#AppBlockBuilder" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#StopFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#StopFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#StopFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Stops the specified fleet.
" - } - }, - "com.amazonaws.appstream#StopFleetRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#StopFleetResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#StopImageBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#StopImageBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#StopImageBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Stops the specified image builder.
" - } - }, - "com.amazonaws.appstream#StopImageBuilderRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the image builder.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#StopImageBuilderResult": { - "type": "structure", - "members": { - "ImageBuilder": { - "target": "com.amazonaws.appstream#ImageBuilder", - "traits": { - "smithy.api#documentation": "Information about the image builder.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#StorageConnector": { - "type": "structure", - "members": { - "ConnectorType": { - "target": "com.amazonaws.appstream#StorageConnectorType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of storage connector.
", - "smithy.api#required": {} - } - }, - "ResourceIdentifier": { - "target": "com.amazonaws.appstream#ResourceIdentifier", - "traits": { - "smithy.api#documentation": "The ARN of the storage connector.
" - } - }, - "Domains": { - "target": "com.amazonaws.appstream#DomainList", - "traits": { - "smithy.api#documentation": "The names of the domains for the account.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a connector that enables persistent storage for users.
" - } - }, - "com.amazonaws.appstream#StorageConnectorList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#StorageConnector" - }, - "traits": { - "smithy.api#documentation": "The storage connectors.
" - } - }, - "com.amazonaws.appstream#StorageConnectorType": { - "type": "enum", - "members": { - "HOMEFOLDERS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOMEFOLDERS" - } - }, - "GOOGLE_DRIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GOOGLE_DRIVE" - } - }, - "ONE_DRIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_DRIVE" - } - } - }, - "traits": { - "smithy.api#documentation": "The type of storage connector.
" - } - }, - "com.amazonaws.appstream#StreamView": { - "type": "enum", - "members": { - "APP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APP" - } - }, - "DESKTOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESKTOP" - } - } - } - }, - "com.amazonaws.appstream#StreamingExperienceSettings": { - "type": "structure", - "members": { - "PreferredProtocol": { - "target": "com.amazonaws.appstream#PreferredProtocol", - "traits": { - "smithy.api#documentation": "The preferred protocol that you want to use while streaming your application.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" - } - }, - "com.amazonaws.appstream#StreamingUrlUserId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 32 - }, - "smithy.api#pattern": "^[\\w+=,.@-]*$" - } - }, - "com.amazonaws.appstream#String": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.appstream#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#String" - } - }, - "com.amazonaws.appstream#SubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#String" - }, - "traits": { - "smithy.api#documentation": "The subnet identifiers.
" - } - }, - "com.amazonaws.appstream#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(^(?!aws:).[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.appstream#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.appstream#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.appstream#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" - }, - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.
\nEach tag consists of a key and an optional value. If a resource already has a tag with the same key, \n this operation updates its value.
\nTo list the current tags for your resources, use ListTagsForResource.\n To disassociate tags from your resources, use UntagResource.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "com.amazonaws.appstream#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
\nIf you do not specify a value, the value is set to an empty string.
\nGenerally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
\n_ . : / = + \\ - @
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.appstream#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.appstream#TagKey" - }, - "value": { - "target": "com.amazonaws.appstream#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.appstream#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.appstream#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.appstream#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates one or more specified tags from the specified AppStream 2.0 resource.
\nTo list the current tags for your resources, use ListTagsForResource.
\nFor more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "com.amazonaws.appstream#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.appstream#TagKeyList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The tag keys for the tags to disassociate.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#UpdateAppBlockBuilder": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#UpdateAppBlockBuilderRequest" - }, - "output": { - "target": "com.amazonaws.appstream#UpdateAppBlockBuilderResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" + "com.amazonaws.appstream#UpdateFleetResult": { + "type": "structure", + "members": { + "Fleet": { + "target": "com.amazonaws.appstream#Fleet", + "traits": { + "smithy.api#documentation": "Information about the fleet.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + "com.amazonaws.appstream#UpdateImagePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateImagePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#UpdateImagePermissionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotAvailableException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Adds or updates permissions for the specified private image.
" + } }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" + "com.amazonaws.appstream#UpdateImagePermissionsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the private image.
", + "smithy.api#required": {} + } + }, + "SharedAccountId": { + "target": "com.amazonaws.appstream#AwsAccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The 12-digit identifier of the AWS account for which you want add or update image permissions.
", + "smithy.api#required": {} + } + }, + "ImagePermissions": { + "target": "com.amazonaws.appstream#ImagePermissions", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The permissions for the image.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.appstream#LimitExceededException" + "com.amazonaws.appstream#UpdateImagePermissionsResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" + "com.amazonaws.appstream#UpdateStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateStackRequest" + }, + "output": { + "target": "com.amazonaws.appstream#UpdateStackResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#IncompatibleImageException" + }, + { + "target": "com.amazonaws.appstream#InvalidAccountStatusException" + }, + { + "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.appstream#InvalidRoleException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceInUseException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified fields for the specified stack.
" + } }, - { - "target": "com.amazonaws.appstream#RequestLimitExceededException" + "com.amazonaws.appstream#UpdateStackRequest": { + "type": "structure", + "members": { + "DisplayName": { + "target": "com.amazonaws.appstream#DisplayName", + "traits": { + "smithy.api#documentation": "The stack name to display.
" + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description to display.
" + } + }, + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "StorageConnectors": { + "target": "com.amazonaws.appstream#StorageConnectorList", + "traits": { + "smithy.api#documentation": "The storage connectors to enable.
" + } + }, + "DeleteStorageConnectors": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Deletes the storage connectors currently enabled for the stack.
" + } + }, + "RedirectURL": { + "target": "com.amazonaws.appstream#RedirectURL", + "traits": { + "smithy.api#documentation": "The URL that users are redirected to after their streaming session ends.
" + } + }, + "FeedbackURL": { + "target": "com.amazonaws.appstream#FeedbackURL", + "traits": { + "smithy.api#documentation": "The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
" + } + }, + "AttributesToDelete": { + "target": "com.amazonaws.appstream#StackAttributes", + "traits": { + "smithy.api#documentation": "The stack attributes to delete.
" + } + }, + "UserSettings": { + "target": "com.amazonaws.appstream#UserSettingList", + "traits": { + "smithy.api#documentation": "The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
" + } + }, + "ApplicationSettings": { + "target": "com.amazonaws.appstream#ApplicationSettings", + "traits": { + "smithy.api#documentation": "The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
" + } + }, + "AccessEndpoints": { + "target": "com.amazonaws.appstream#AccessEndpointList", + "traits": { + "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
" + } + }, + "EmbedHostDomains": { + "target": "com.amazonaws.appstream#EmbedHostDomains", + "traits": { + "smithy.api#documentation": "The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
" + } + }, + "StreamingExperienceSettings": { + "target": "com.amazonaws.appstream#StreamingExperienceSettings", + "traits": { + "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" + "com.amazonaws.appstream#UpdateStackResult": { + "type": "structure", + "members": { + "Stack": { + "target": "com.amazonaws.appstream#Stack", + "traits": { + "smithy.api#documentation": "Information about the stack.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" + "com.amazonaws.appstream#UsageReportExecutionErrorCode": { + "type": "enum", + "members": { + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_NOT_FOUND" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + } + } }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Updates an app block builder.
\nIf the app block builder is in the STARTING or STOPPING\n state, you can't update it. If the app block builder is in the RUNNING\n state, you can only update the DisplayName and Description. If the app block builder is\n in the STOPPED state, you can update any attribute except the Name.
The unique name for the app block builder.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the app block builder.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The display name of the app block builder.
" - } - }, - "Platform": { - "target": "com.amazonaws.appstream#PlatformType", - "traits": { - "smithy.api#documentation": "The platform of the app block builder.
\n\n WINDOWS_SERVER_2019 is the only valid value.
The instance type to use when launching the app block builder. The following instance\n types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe VPC configuration for the app block builder.
\nApp block builders require that you specify at least two subnets in different availability\n zones.
" - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Enables or disables default internet access for the app block builder.
" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To\n assume a role, the app block builder calls the AWS Security Token Service (STS)\n AssumeRole API operation and passes the ARN of the role to use. The\n operation creates a new session with temporary credentials. AppStream 2.0 retrieves the\n temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
" - } - }, - "AttributesToDelete": { - "target": "com.amazonaws.appstream#AppBlockBuilderAttributes", - "traits": { - "smithy.api#documentation": "The attributes to delete from the app block builder.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UpdateAppBlockBuilderResult": { - "type": "structure", - "members": { - "AppBlockBuilder": { - "target": "com.amazonaws.appstream#AppBlockBuilder" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#UpdateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#UpdateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.appstream#UpdateApplicationResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the specified application.
" - } - }, - "com.amazonaws.appstream#UpdateApplicationRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the application. This name is visible to users when display name is not specified.
", - "smithy.api#required": {} - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The display name of the application. This name is visible to users in the application catalog.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the application.
" - } - }, - "IconS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#documentation": "The icon S3 location of the application.
" - } - }, - "LaunchPath": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The launch path of the application.
" - } - }, - "WorkingDirectory": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The working directory of the application.
" - } - }, - "LaunchParameters": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The launch parameters of the application.
" - } - }, - "AppBlockArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the app block.
" - } - }, - "AttributesToDelete": { - "target": "com.amazonaws.appstream#ApplicationAttributes", - "traits": { - "smithy.api#documentation": "The attributes to delete for an application.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UpdateApplicationResult": { - "type": "structure", - "members": { - "Application": { - "target": "com.amazonaws.appstream#Application" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#UpdateDirectoryConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#UpdateDirectoryConfigRequest" - }, - "output": { - "target": "com.amazonaws.appstream#UpdateDirectoryConfigResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" - }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" - }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" - }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
" - } - }, - "com.amazonaws.appstream#UpdateDirectoryConfigRequest": { - "type": "structure", - "members": { - "DirectoryName": { - "target": "com.amazonaws.appstream#DirectoryName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the Directory Config object.
", - "smithy.api#required": {} - } - }, - "OrganizationalUnitDistinguishedNames": { - "target": "com.amazonaws.appstream#OrganizationalUnitDistinguishedNamesList", - "traits": { - "smithy.api#documentation": "The distinguished names of the organizational units for computer accounts.
" - } - }, - "ServiceAccountCredentials": { - "target": "com.amazonaws.appstream#ServiceAccountCredentials", - "traits": { - "smithy.api#documentation": "The credentials for the service account used by the fleet or image builder to connect to the directory.
" - } - }, - "CertificateBasedAuthProperties": { - "target": "com.amazonaws.appstream#CertificateBasedAuthProperties", - "traits": { - "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity\n Provider (IdP) user identities to Active Directory domain-joined streaming instances.\n Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD\n domain password if certificate-based authentication is unsuccessful, or to unlock a\n desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based\n authentication, but does not allow users to log in using their AD domain password. Users\n will be disconnected to re-authenticate using certificates.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UpdateDirectoryConfigResult": { - "type": "structure", - "members": { - "DirectoryConfig": { - "target": "com.amazonaws.appstream#DirectoryConfig", - "traits": { - "smithy.api#documentation": "Information about the Directory Config object.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "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#clientOptional": {}, - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "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.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UpdateEntitlementResult": { - "type": "structure", - "members": { - "Entitlement": { - "target": "com.amazonaws.appstream#Entitlement", - "traits": { - "smithy.api#documentation": "The entitlement.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#UpdateFleet": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#UpdateFleetRequest" - }, - "output": { - "target": "com.amazonaws.appstream#UpdateFleetResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" + "com.amazonaws.appstream#UsageReportSchedule": { + "type": "enum", + "members": { + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + } + } }, - { - "target": "com.amazonaws.appstream#IncompatibleImageException" + "com.amazonaws.appstream#UsageReportSubscription": { + "type": "structure", + "members": { + "S3BucketName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket where generated reports are stored.
\nIf you enabled on-instance session scripts and Amazon S3 logging for your session script\n configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is\n unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0\n uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, \n when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
" + } + }, + "Schedule": { + "target": "com.amazonaws.appstream#UsageReportSchedule", + "traits": { + "smithy.api#documentation": "The schedule for generating usage reports.
" + } + }, + "LastGeneratedReportDate": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the last usage report was generated.
" + } + }, + "SubscriptionErrors": { + "target": "com.amazonaws.appstream#LastReportGenerationExecutionErrors", + "traits": { + "smithy.api#documentation": "The errors that were returned if usage reports couldn't be generated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes information about the usage report subscription.
" + } }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" + "com.amazonaws.appstream#UsageReportSubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#UsageReportSubscription" + } }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + "com.amazonaws.appstream#UsbDeviceFilterString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^((\\w*)\\s*(\\w*)\\s*\\,\\s*(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*[0-1]\\s*\\,\\s*[0-1]\\s*)$" + } }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" + "com.amazonaws.appstream#UsbDeviceFilterStrings": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#UsbDeviceFilterString" + } }, - { - "target": "com.amazonaws.appstream#LimitExceededException" + "com.amazonaws.appstream#User": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the user.
" + } + }, + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive.
\nSpecifies whether the user in the user pool is enabled.
" + } + }, + "Status": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The status of the user in the user pool. The status can be one of the following:
\nUNCONFIRMED – The user is created but not confirmed.
\nCONFIRMED – The user is confirmed.
\nARCHIVED – The user is no longer active.
\nCOMPROMISED – The user is disabled because of a potential security threat.
\nUNKNOWN – The user status is not known.
\nThe first name, or given name, of the user.
" + } + }, + "LastName": { + "target": "com.amazonaws.appstream#UserAttributeValue", + "traits": { + "smithy.api#documentation": "The last name, or surname, of the user.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the user was created in the user pool.
" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.appstream#AuthenticationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The authentication type for the user.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a user in the user pool.
" + } }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" + "com.amazonaws.appstream#UserAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[A-Za-z0-9_\\-\\s]+$", + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.appstream#RequestLimitExceededException" + "com.amazonaws.appstream#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 128 + } + } }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" + "com.amazonaws.appstream#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#User" + } }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" + "com.amazonaws.appstream#UserSetting": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.appstream#Action", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The action that is enabled or disabled.
", + "smithy.api#required": {} + } + }, + "Permission": { + "target": "com.amazonaws.appstream#Permission", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Indicates whether the action is enabled or disabled.
", + "smithy.api#required": {} + } + }, + "MaximumLength": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session.
\nThis can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions.
This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED.
This can only be specified for AlwaysOn and OnDemand fleets. The attribute is not supported on Elastic fleets.
\nThe value can be between 1 and 20,971,520 (20 MB).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
" + } }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the specified fleet.
\nIf the fleet is in the STOPPED state, you can update any attribute except\n the fleet name.
If the fleet is in the RUNNING state, you can update the following based\n on the fleet type:
Always-On and On-Demand fleet types
\nYou can update the DisplayName, ComputeCapacity,\n ImageARN, ImageName,\n IdleDisconnectTimeoutInSeconds, and\n DisconnectTimeoutInSeconds attributes.
Elastic fleet type
\nYou can update the DisplayName,\n IdleDisconnectTimeoutInSeconds,\n DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location\n and UsbDeviceFilterStrings attributes.
If the fleet is in the STARTING or STOPPED state, you can't update it.
The name of the image used to create the fleet.
" - } - }, - "ImageArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the public, private, or shared image to use.
" - } - }, - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "A unique name for the fleet.
" - } - }, - "InstanceType": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The instance type to use when launching fleet instances. The following instance types are available:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nstream.compute.large
\nstream.compute.xlarge
\nstream.compute.2xlarge
\nstream.compute.4xlarge
\nstream.compute.8xlarge
\nstream.memory.large
\nstream.memory.xlarge
\nstream.memory.2xlarge
\nstream.memory.4xlarge
\nstream.memory.8xlarge
\nstream.memory.z1d.large
\nstream.memory.z1d.xlarge
\nstream.memory.z1d.2xlarge
\nstream.memory.z1d.3xlarge
\nstream.memory.z1d.6xlarge
\nstream.memory.z1d.12xlarge
\nstream.graphics-design.large
\nstream.graphics-design.xlarge
\nstream.graphics-design.2xlarge
\nstream.graphics-design.4xlarge
\nstream.graphics-desktop.2xlarge
\nstream.graphics.g4dn.xlarge
\nstream.graphics.g4dn.2xlarge
\nstream.graphics.g4dn.4xlarge
\nstream.graphics.g4dn.8xlarge
\nstream.graphics.g4dn.12xlarge
\nstream.graphics.g4dn.16xlarge
\nstream.graphics-pro.4xlarge
\nstream.graphics-pro.8xlarge
\nstream.graphics-pro.16xlarge
\nThe following instance types are available for Elastic fleets:
\nstream.standard.small
\nstream.standard.medium
\nstream.standard.large
\nstream.standard.xlarge
\nstream.standard.2xlarge
\nThe desired capacity for the fleet. This is not allowed for Elastic fleets.
" - } - }, - "VpcConfig": { - "target": "com.amazonaws.appstream#VpcConfig", - "traits": { - "smithy.api#documentation": "The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
" - } - }, - "MaxUserDurationInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
\nSpecify a value between 600 and 432000.
" - } - }, - "DisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
\nSpecify a value between 60 and 360000.
" - } - }, - "DeleteVpcConfig": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Deletes the VPC association for the specified fleet.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The fleet name to display.
" - } - }, - "EnableDefaultInternetAccess": { - "target": "com.amazonaws.appstream#BooleanObject", - "traits": { - "smithy.api#documentation": "Enables or disables default internet access for the fleet.
" - } - }, - "DomainJoinInfo": { - "target": "com.amazonaws.appstream#DomainJoinInfo", - "traits": { - "smithy.api#documentation": "The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
" - } - }, - "IdleDisconnectTimeoutInSeconds": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected\n from their streaming session and the DisconnectTimeoutInSeconds time\n interval begins. Users are notified before they are disconnected due to inactivity. If\n users try to reconnect to the streaming session before the time interval specified in\n DisconnectTimeoutInSeconds elapses, they are connected to their\n previous session. Users are considered idle when they stop providing keyboard or mouse\n input during their streaming session. File uploads and downloads, audio in, audio out,\n and pixels changing do not qualify as user activity. If users continue to be idle after\n the time interval in IdleDisconnectTimeoutInSeconds elapses, they are\n disconnected.
To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
\nIf you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
\nThe fleet attributes to delete.
" - } - }, - "IamRoleArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
" - } - }, - "StreamView": { - "target": "com.amazonaws.appstream#StreamView", - "traits": { - "smithy.api#documentation": "The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays.
The default value is APP.
The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
" - } - }, - "MaxConcurrentSessions": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of concurrent sessions for a fleet.
" - } - }, - "UsbDeviceFilterStrings": { - "target": "com.amazonaws.appstream#UsbDeviceFilterStrings", - "traits": { - "smithy.api#documentation": "The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
" - } - }, - "SessionScriptS3Location": { - "target": "com.amazonaws.appstream#S3Location", - "traits": { - "smithy.api#documentation": "The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
" - } - }, - "MaxSessionsPerInstance": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of user sessions on an instance. This only applies to multi-session fleets.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UpdateFleetResult": { - "type": "structure", - "members": { - "Fleet": { - "target": "com.amazonaws.appstream#Fleet", - "traits": { - "smithy.api#documentation": "Information about the fleet.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#UpdateImagePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#UpdateImagePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.appstream#UpdateImagePermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#LimitExceededException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotAvailableException" - }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Adds or updates permissions for the specified private image.
" - } - }, - "com.amazonaws.appstream#UpdateImagePermissionsRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the private image.
", - "smithy.api#required": {} - } - }, - "SharedAccountId": { - "target": "com.amazonaws.appstream#AwsAccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The 12-digit identifier of the AWS account for which you want add or update image permissions.
", - "smithy.api#required": {} - } - }, - "ImagePermissions": { - "target": "com.amazonaws.appstream#ImagePermissions", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The permissions for the image.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UpdateImagePermissionsResult": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#UpdateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.appstream#UpdateStackRequest" - }, - "output": { - "target": "com.amazonaws.appstream#UpdateStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.appstream#ConcurrentModificationException" + "com.amazonaws.appstream#UserSettingList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#UserSetting" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.appstream#IncompatibleImageException" + "com.amazonaws.appstream#UserStackAssociation": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the stack that is associated with the user.
", + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.appstream#Username", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the user who is associated with the stack.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user.
", + "smithy.api#required": {} + } + }, + "SendEmailNotification": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether a welcome email is sent to a user after the user is created in the user pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a user in the user pool and the associated stack.
" + } }, - { - "target": "com.amazonaws.appstream#InvalidAccountStatusException" + "com.amazonaws.appstream#UserStackAssociationError": { + "type": "structure", + "members": { + "UserStackAssociation": { + "target": "com.amazonaws.appstream#UserStackAssociation", + "traits": { + "smithy.api#documentation": "Information about the user and associated stack.
" + } + }, + "ErrorCode": { + "target": "com.amazonaws.appstream#UserStackAssociationErrorCode", + "traits": { + "smithy.api#documentation": "The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
" + } }, - { - "target": "com.amazonaws.appstream#InvalidParameterCombinationException" + "com.amazonaws.appstream#UserStackAssociationErrorCode": { + "type": "enum", + "members": { + "STACK_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACK_NOT_FOUND" + } + }, + "USER_NAME_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER_NAME_NOT_FOUND" + } + }, + "DIRECTORY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_NOT_FOUND" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + } + } }, - { - "target": "com.amazonaws.appstream#InvalidRoleException" + "com.amazonaws.appstream#UserStackAssociationErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#UserStackAssociationError" + } }, - { - "target": "com.amazonaws.appstream#LimitExceededException" + "com.amazonaws.appstream#UserStackAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#UserStackAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } }, - { - "target": "com.amazonaws.appstream#OperationNotPermittedException" + "com.amazonaws.appstream#Username": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$", + "smithy.api#sensitive": {} + } }, - { - "target": "com.amazonaws.appstream#ResourceInUseException" + "com.amazonaws.appstream#VisibilityType": { + "type": "enum", + "members": { + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC" + } + }, + "PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATE" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } + } }, - { - "target": "com.amazonaws.appstream#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the specified fields for the specified stack.
" - } - }, - "com.amazonaws.appstream#UpdateStackRequest": { - "type": "structure", - "members": { - "DisplayName": { - "target": "com.amazonaws.appstream#DisplayName", - "traits": { - "smithy.api#documentation": "The stack name to display.
" - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description to display.
" - } - }, - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "StorageConnectors": { - "target": "com.amazonaws.appstream#StorageConnectorList", - "traits": { - "smithy.api#documentation": "The storage connectors to enable.
" - } - }, - "DeleteStorageConnectors": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Deletes the storage connectors currently enabled for the stack.
" - } - }, - "RedirectURL": { - "target": "com.amazonaws.appstream#RedirectURL", - "traits": { - "smithy.api#documentation": "The URL that users are redirected to after their streaming session ends.
" - } - }, - "FeedbackURL": { - "target": "com.amazonaws.appstream#FeedbackURL", - "traits": { - "smithy.api#documentation": "The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
" - } - }, - "AttributesToDelete": { - "target": "com.amazonaws.appstream#StackAttributes", - "traits": { - "smithy.api#documentation": "The stack attributes to delete.
" - } - }, - "UserSettings": { - "target": "com.amazonaws.appstream#UserSettingList", - "traits": { - "smithy.api#documentation": "The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
" - } - }, - "ApplicationSettings": { - "target": "com.amazonaws.appstream#ApplicationSettings", - "traits": { - "smithy.api#documentation": "The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
" - } - }, - "AccessEndpoints": { - "target": "com.amazonaws.appstream#AccessEndpointList", - "traits": { - "smithy.api#documentation": "The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
" - } - }, - "EmbedHostDomains": { - "target": "com.amazonaws.appstream#EmbedHostDomains", - "traits": { - "smithy.api#documentation": "The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
" - } - }, - "StreamingExperienceSettings": { - "target": "com.amazonaws.appstream#StreamingExperienceSettings", - "traits": { - "smithy.api#documentation": "The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.appstream#UpdateStackResult": { - "type": "structure", - "members": { - "Stack": { - "target": "com.amazonaws.appstream#Stack", - "traits": { - "smithy.api#documentation": "Information about the stack.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.appstream#UsageReportExecutionErrorCode": { - "type": "enum", - "members": { - "RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_NOT_FOUND" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" - } - } - } - }, - "com.amazonaws.appstream#UsageReportSchedule": { - "type": "enum", - "members": { - "DAILY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAILY" - } - } - } - }, - "com.amazonaws.appstream#UsageReportSubscription": { - "type": "structure", - "members": { - "S3BucketName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The Amazon S3 bucket where generated reports are stored.
\nIf you enabled on-instance session scripts and Amazon S3 logging for your session script\n configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is\n unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0\n uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, \n when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
" - } - }, - "Schedule": { - "target": "com.amazonaws.appstream#UsageReportSchedule", - "traits": { - "smithy.api#documentation": "The schedule for generating usage reports.
" - } - }, - "LastGeneratedReportDate": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the last usage report was generated.
" - } - }, - "SubscriptionErrors": { - "target": "com.amazonaws.appstream#LastReportGenerationExecutionErrors", - "traits": { - "smithy.api#documentation": "The errors that were returned if usage reports couldn't be generated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes information about the usage report subscription.
" - } - }, - "com.amazonaws.appstream#UsageReportSubscriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#UsageReportSubscription" - } - }, - "com.amazonaws.appstream#UsbDeviceFilterString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#pattern": "^((\\w*)\\s*(\\w*)\\s*\\,\\s*(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?(\\w*)\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*\\*?\\d*\\s*\\,\\s*[0-1]\\s*\\,\\s*[0-1]\\s*)$" - } - }, - "com.amazonaws.appstream#UsbDeviceFilterStrings": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#UsbDeviceFilterString" - } - }, - "com.amazonaws.appstream#User": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the user.
" - } - }, - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#documentation": "The email address of the user.
\nUsers' email addresses are case-sensitive.
\nSpecifies whether the user in the user pool is enabled.
" - } - }, - "Status": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The status of the user in the user pool. The status can be one of the following:
\nUNCONFIRMED – The user is created but not confirmed.
\nCONFIRMED – The user is confirmed.
\nARCHIVED – The user is no longer active.
\nCOMPROMISED – The user is disabled because of a potential security threat.
\nUNKNOWN – The user status is not known.
\nThe first name, or given name, of the user.
" - } - }, - "LastName": { - "target": "com.amazonaws.appstream#UserAttributeValue", - "traits": { - "smithy.api#documentation": "The last name, or surname, of the user.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time the user was created in the user pool.
" - } - }, - "AuthenticationType": { - "target": "com.amazonaws.appstream#AuthenticationType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The authentication type for the user.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a user in the user pool.
" - } - }, - "com.amazonaws.appstream#UserAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#pattern": "^[A-Za-z0-9_\\-\\s]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.appstream#UserId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 128 - } - } - }, - "com.amazonaws.appstream#UserList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#User" - } - }, - "com.amazonaws.appstream#UserSetting": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.appstream#Action", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The action that is enabled or disabled.
", - "smithy.api#required": {} - } - }, - "Permission": { - "target": "com.amazonaws.appstream#Permission", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Indicates whether the action is enabled or disabled.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an action and whether the action is enabled or disabled for users during their streaming sessions.
" - } - }, - "com.amazonaws.appstream#UserSettingList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#UserSetting" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.appstream#UserStackAssociation": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the stack that is associated with the user.
", - "smithy.api#required": {} - } - }, - "UserName": { - "target": "com.amazonaws.appstream#Username", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The email address of the user who is associated with the stack.
\nUsers' email addresses are case-sensitive.
\nThe authentication type for the user.
", - "smithy.api#required": {} - } - }, - "SendEmailNotification": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#documentation": "Specifies whether a welcome email is sent to a user after the user is created in the user pool.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes a user in the user pool and the associated stack.
" - } - }, - "com.amazonaws.appstream#UserStackAssociationError": { - "type": "structure", - "members": { - "UserStackAssociation": { - "target": "com.amazonaws.appstream#UserStackAssociation", - "traits": { - "smithy.api#documentation": "Information about the user and associated stack.
" - } - }, - "ErrorCode": { - "target": "com.amazonaws.appstream#UserStackAssociationErrorCode", - "traits": { - "smithy.api#documentation": "The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the error that is returned when a user can’t be associated with or disassociated from a stack.
" - } - }, - "com.amazonaws.appstream#UserStackAssociationErrorCode": { - "type": "enum", - "members": { - "STACK_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STACK_NOT_FOUND" - } - }, - "USER_NAME_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER_NAME_NOT_FOUND" - } - }, - "DIRECTORY_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECTORY_NOT_FOUND" - } - }, - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - } - } - }, - "com.amazonaws.appstream#UserStackAssociationErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#UserStackAssociationError" - } - }, - "com.amazonaws.appstream#UserStackAssociationList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#UserStackAssociation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 25 - } - } - }, - "com.amazonaws.appstream#Username": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.appstream#VisibilityType": { - "type": "enum", - "members": { - "PUBLIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLIC" - } - }, - "PRIVATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIVATE" - } - }, - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED" - } - } - } - }, - "com.amazonaws.appstream#VpcConfig": { - "type": "structure", - "members": { - "SubnetIds": { - "target": "com.amazonaws.appstream#SubnetIdList", - "traits": { - "smithy.api#documentation": "The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.appstream#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "The identifiers of the security groups for the fleet or image builder.
" - } + "com.amazonaws.appstream#VpcConfig": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.appstream#SubnetIdList", + "traits": { + "smithy.api#documentation": "The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.appstream#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "The identifiers of the security groups for the fleet or image builder.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes VPC configuration information for fleets and image builders.
" + } } - }, - "traits": { - "smithy.api#documentation": "Describes VPC configuration information for fleets and image builders.
" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/eks.json b/codegen/sdk-codegen/aws-models/eks.json index 3b5be861508be..85b8a563ad2d6 100644 --- a/codegen/sdk-codegen/aws-models/eks.json +++ b/codegen/sdk-codegen/aws-models/eks.json @@ -1,10213 +1,10773 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.eks#AMITypes": { - "type": "enum", - "members": { - "AL2_x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AL2_x86_64" - } - }, - "AL2_x86_64_GPU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AL2_x86_64_GPU" - } - }, - "AL2_ARM_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AL2_ARM_64" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - }, - "BOTTLEROCKET_ARM_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTLEROCKET_ARM_64" - } - }, - "BOTTLEROCKET_x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTLEROCKET_x86_64" - } - }, - "BOTTLEROCKET_ARM_64_NVIDIA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTLEROCKET_ARM_64_NVIDIA" - } - }, - "BOTTLEROCKET_x86_64_NVIDIA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTLEROCKET_x86_64_NVIDIA" - } - }, - "WINDOWS_CORE_2019_x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_CORE_2019_x86_64" - } - }, - "WINDOWS_FULL_2019_x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_FULL_2019_x86_64" - } - }, - "WINDOWS_CORE_2022_x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_CORE_2022_x86_64" - } - }, - "WINDOWS_FULL_2022_x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WINDOWS_FULL_2022_x86_64" - } - } - } - }, - "com.amazonaws.eks#AWSWesleyFrontend": { - "type": "service", - "version": "2017-11-01", - "operations": [ - { - "target": "com.amazonaws.eks#AssociateAccessPolicy" - }, - { - "target": "com.amazonaws.eks#AssociateEncryptionConfig" - }, - { - "target": "com.amazonaws.eks#AssociateIdentityProviderConfig" - }, - { - "target": "com.amazonaws.eks#CreateAccessEntry" - }, - { - "target": "com.amazonaws.eks#CreateAddon" - }, - { - "target": "com.amazonaws.eks#CreateCluster" - }, - { - "target": "com.amazonaws.eks#CreateEksAnywhereSubscription" - }, - { - "target": "com.amazonaws.eks#CreateFargateProfile" - }, - { - "target": "com.amazonaws.eks#CreateNodegroup" - }, - { - "target": "com.amazonaws.eks#CreatePodIdentityAssociation" - }, - { - "target": "com.amazonaws.eks#DeleteAccessEntry" - }, - { - "target": "com.amazonaws.eks#DeleteAddon" - }, - { - "target": "com.amazonaws.eks#DeleteCluster" - }, - { - "target": "com.amazonaws.eks#DeleteEksAnywhereSubscription" - }, - { - "target": "com.amazonaws.eks#DeleteFargateProfile" - }, - { - "target": "com.amazonaws.eks#DeleteNodegroup" - }, - { - "target": "com.amazonaws.eks#DeletePodIdentityAssociation" - }, - { - "target": "com.amazonaws.eks#DeregisterCluster" - }, - { - "target": "com.amazonaws.eks#DescribeAccessEntry" - }, - { - "target": "com.amazonaws.eks#DescribeAddon" - }, - { - "target": "com.amazonaws.eks#DescribeAddonConfiguration" - }, - { - "target": "com.amazonaws.eks#DescribeAddonVersions" - }, - { - "target": "com.amazonaws.eks#DescribeCluster" - }, - { - "target": "com.amazonaws.eks#DescribeEksAnywhereSubscription" - }, - { - "target": "com.amazonaws.eks#DescribeFargateProfile" - }, - { - "target": "com.amazonaws.eks#DescribeIdentityProviderConfig" - }, - { - "target": "com.amazonaws.eks#DescribeNodegroup" - }, - { - "target": "com.amazonaws.eks#DescribePodIdentityAssociation" - }, - { - "target": "com.amazonaws.eks#DescribeUpdate" - }, - { - "target": "com.amazonaws.eks#DisassociateAccessPolicy" - }, - { - "target": "com.amazonaws.eks#DisassociateIdentityProviderConfig" - }, - { - "target": "com.amazonaws.eks#ListAccessEntries" - }, - { - "target": "com.amazonaws.eks#ListAccessPolicies" - }, - { - "target": "com.amazonaws.eks#ListAddons" - }, - { - "target": "com.amazonaws.eks#ListAssociatedAccessPolicies" - }, - { - "target": "com.amazonaws.eks#ListClusters" - }, - { - "target": "com.amazonaws.eks#ListEksAnywhereSubscriptions" - }, - { - "target": "com.amazonaws.eks#ListFargateProfiles" - }, - { - "target": "com.amazonaws.eks#ListIdentityProviderConfigs" - }, - { - "target": "com.amazonaws.eks#ListNodegroups" - }, - { - "target": "com.amazonaws.eks#ListPodIdentityAssociations" - }, - { - "target": "com.amazonaws.eks#ListTagsForResource" - }, - { - "target": "com.amazonaws.eks#ListUpdates" - }, - { - "target": "com.amazonaws.eks#RegisterCluster" - }, - { - "target": "com.amazonaws.eks#TagResource" - }, - { - "target": "com.amazonaws.eks#UntagResource" - }, - { - "target": "com.amazonaws.eks#UpdateAccessEntry" - }, - { - "target": "com.amazonaws.eks#UpdateAddon" - }, - { - "target": "com.amazonaws.eks#UpdateClusterConfig" - }, - { - "target": "com.amazonaws.eks#UpdateClusterVersion" - }, - { - "target": "com.amazonaws.eks#UpdateEksAnywhereSubscription" - }, - { - "target": "com.amazonaws.eks#UpdateNodegroupConfig" - }, - { - "target": "com.amazonaws.eks#UpdateNodegroupVersion" - }, - { - "target": "com.amazonaws.eks#UpdatePodIdentityAssociation" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "EKS", - "arnNamespace": "eks", - "cloudFormationName": "EKS", - "cloudTrailEventSource": "eks.amazonaws.com", - "endpointPrefix": "eks" - }, - "aws.auth#sigv4": { - "name": "eks" - }, - "aws.protocols#restJson1": {}, - "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 setup or maintain your own\n Kubernetes control plane. Kubernetes is an open-source system for automating the deployment,\n scaling, and management of containerized applications.
\nAmazon EKS runs up-to-date versions of the open-source Kubernetes software, so you\n can use all the existing plugins and tooling from the Kubernetes community. Applications\n running on Amazon EKS are fully compatible with applications running on any\n standard Kubernetes environment, whether running in on-premises data centers or public\n clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.
", - "smithy.api#title": "Amazon Elastic Kubernetes Service", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ + "smithy": "2.0", + "metadata": { + "suppressions": [ { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.eks#AMITypes": { + "type": "enum", + "members": { + "AL2_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2_x86_64" + } + }, + "AL2_x86_64_GPU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2_x86_64_GPU" + } + }, + "AL2_ARM_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AL2_ARM_64" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "BOTTLEROCKET_ARM_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_ARM_64" + } + }, + "BOTTLEROCKET_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_x86_64" + } + }, + "BOTTLEROCKET_ARM_64_NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_ARM_64_NVIDIA" + } + }, + "BOTTLEROCKET_x86_64_NVIDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTLEROCKET_x86_64_NVIDIA" + } + }, + "WINDOWS_CORE_2019_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_CORE_2019_x86_64" + } + }, + "WINDOWS_FULL_2019_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_FULL_2019_x86_64" + } + }, + "WINDOWS_CORE_2022_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_CORE_2022_x86_64" + } + }, + "WINDOWS_FULL_2022_x86_64": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_FULL_2022_x86_64" } - ] } - ], - "rules": [ + } + }, + "com.amazonaws.eks#AWSWesleyFrontend": { + "type": "service", + "version": "2017-11-01", + "operations": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.eks#AssociateAccessPolicy" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.eks#AssociateEncryptionConfig" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ + "target": "com.amazonaws.eks#AssociateIdentityProviderConfig" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ + "target": "com.amazonaws.eks#CreateAccessEntry" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "target": "com.amazonaws.eks#CreateAddon" + }, + { + "target": "com.amazonaws.eks#CreateCluster" + }, + { + "target": "com.amazonaws.eks#CreateEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#CreateFargateProfile" + }, + { + "target": "com.amazonaws.eks#CreateNodegroup" + }, + { + "target": "com.amazonaws.eks#CreatePodIdentityAssociation" + }, + { + "target": "com.amazonaws.eks#DeleteAccessEntry" + }, + { + "target": "com.amazonaws.eks#DeleteAddon" + }, + { + "target": "com.amazonaws.eks#DeleteCluster" + }, + { + "target": "com.amazonaws.eks#DeleteEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#DeleteFargateProfile" + }, + { + "target": "com.amazonaws.eks#DeleteNodegroup" + }, + { + "target": "com.amazonaws.eks#DeletePodIdentityAssociation" + }, + { + "target": "com.amazonaws.eks#DeregisterCluster" + }, + { + "target": "com.amazonaws.eks#DescribeAccessEntry" + }, + { + "target": "com.amazonaws.eks#DescribeAddon" + }, + { + "target": "com.amazonaws.eks#DescribeAddonConfiguration" + }, + { + "target": "com.amazonaws.eks#DescribeAddonVersions" + }, + { + "target": "com.amazonaws.eks#DescribeCluster" + }, + { + "target": "com.amazonaws.eks#DescribeEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#DescribeFargateProfile" + }, + { + "target": "com.amazonaws.eks#DescribeIdentityProviderConfig" + }, + { + "target": "com.amazonaws.eks#DescribeInsight" + }, + { + "target": "com.amazonaws.eks#DescribeNodegroup" + }, + { + "target": "com.amazonaws.eks#DescribePodIdentityAssociation" + }, + { + "target": "com.amazonaws.eks#DescribeUpdate" + }, + { + "target": "com.amazonaws.eks#DisassociateAccessPolicy" + }, + { + "target": "com.amazonaws.eks#DisassociateIdentityProviderConfig" + }, + { + "target": "com.amazonaws.eks#ListAccessEntries" + }, + { + "target": "com.amazonaws.eks#ListAccessPolicies" + }, + { + "target": "com.amazonaws.eks#ListAddons" + }, + { + "target": "com.amazonaws.eks#ListAssociatedAccessPolicies" + }, + { + "target": "com.amazonaws.eks#ListClusters" + }, + { + "target": "com.amazonaws.eks#ListEksAnywhereSubscriptions" + }, + { + "target": "com.amazonaws.eks#ListFargateProfiles" + }, + { + "target": "com.amazonaws.eks#ListIdentityProviderConfigs" + }, + { + "target": "com.amazonaws.eks#ListInsights" + }, + { + "target": "com.amazonaws.eks#ListNodegroups" + }, + { + "target": "com.amazonaws.eks#ListPodIdentityAssociations" + }, + { + "target": "com.amazonaws.eks#ListTagsForResource" + }, + { + "target": "com.amazonaws.eks#ListUpdates" + }, + { + "target": "com.amazonaws.eks#RegisterCluster" + }, + { + "target": "com.amazonaws.eks#TagResource" + }, + { + "target": "com.amazonaws.eks#UntagResource" + }, + { + "target": "com.amazonaws.eks#UpdateAccessEntry" + }, + { + "target": "com.amazonaws.eks#UpdateAddon" + }, + { + "target": "com.amazonaws.eks#UpdateClusterConfig" + }, + { + "target": "com.amazonaws.eks#UpdateClusterVersion" + }, + { + "target": "com.amazonaws.eks#UpdateEksAnywhereSubscription" + }, + { + "target": "com.amazonaws.eks#UpdateNodegroupConfig" + }, + { + "target": "com.amazonaws.eks#UpdateNodegroupVersion" + }, + { + "target": "com.amazonaws.eks#UpdatePodIdentityAssociation" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EKS", + "arnNamespace": "eks", + "cloudFormationName": "EKS", + "cloudTrailEventSource": "eks.amazonaws.com", + "endpointPrefix": "eks" + }, + "aws.auth#sigv4": { + "name": "eks" + }, + "aws.protocols#restJson1": {}, + "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 setup or maintain your own\n Kubernetes control plane. Kubernetes is an open-source system for automating the deployment,\n scaling, and management of containerized applications.
\nAmazon EKS runs up-to-date versions of the open-source Kubernetes software, so you\n can use all the existing plugins and tooling from the Kubernetes community. Applications\n running on Amazon EKS are fully compatible with applications running on any\n standard Kubernetes environment, whether running in on-premises data centers or public\n clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.
", + "smithy.api#title": "Amazon Elastic Kubernetes Service", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" } - ], - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} }, - "supportsDualStack" - ] + "type": "endpoint" } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://eks-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + ], + "type": "tree" }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ + "fn": "isSet", + "argv": [ { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws" - ] + "ref": "Region" + } + ] } - ], - "endpoint": { - "url": "https://fips.eks.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [ + ], + "rules": [ { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://eks-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" }, - "name" - ] - }, - "aws-us-gov" - ] + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws" + ] + } + ], + "endpoint": { + "url": "https://fips.eks.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://eks.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://eks-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://eks.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://eks.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.af-south-1.amazonaws.com" } - ], - "endpoint": { - "url": "https://eks.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" }, - { - "conditions": [], - "endpoint": { - "url": "https://eks-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-northeast-1.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-northeast-2.amazonaws.com" } - ] + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://eks.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://eks.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fips.eks.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fips.eks.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fips.eks.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://fips.eks.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://eks-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://eks.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://eks-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://eks.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://eks-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://eks.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://eks-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.eks#AccessConfigResponse": { - "type": "structure", - "members": { - "bootstrapClusterCreatorAdminPermissions": { - "target": "com.amazonaws.eks#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Specifies whether or not the cluster creator IAM principal was set as a\n cluster admin access entry during cluster creation time.
" - } - }, - "authenticationMode": { - "target": "com.amazonaws.eks#AuthenticationMode", - "traits": { - "smithy.api#documentation": "The current authentication mode of the cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The access configuration for the cluster.
" - } - }, - "com.amazonaws.eks#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "You do not have sufficient access to perform this action.
" - } - } - }, - "traits": { - "smithy.api#documentation": "You don't have permissions to perform the requested operation. The IAM principal\n making the request must have at least one IAM permissions policy attached\n that grants the required permissions. For more information, see Access\n management in the IAM User Guide.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.eks#AccessEntry": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
" - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the access entry. If you ever delete\n the IAM principal with this ARN, the access entry isn't automatically\n deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever\n recreate the IAM principal, even if it has the same ARN, the access\n entry won't work. This is because even though the ARN is the same for the recreated\n IAM principal, the roleID or userID (you\n can see this with the Security Token Service\n GetCallerIdentity API) is different for the recreated IAM\n principal than it was for the original IAM principal. Even though you\n don't see the IAM principal's roleID or userID\n for an access entry, Amazon EKS stores it with the access entry.
A name that you've specified in a Kubernetes RoleBinding or\n ClusterRoleBinding object so that Kubernetes authorizes the\n principalARN access to cluster objects.
The ARN of the access entry.
" - } - }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" - } - }, - "modifiedAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp for the last modification to the object.
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "username": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of a user that can authenticate to your cluster.
The type of the access entry.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An access entry allows an IAM principal (user or role) to access your\n cluster. Access entries can replace the need to maintain the aws-auth\n ConfigMap for authentication. For more information about access entries,\n see Access\n entries in the Amazon EKS User Guide.
The name of the access policy.
" - } - }, - "arn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the access policy.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An access policy includes permissions that allow Amazon EKS to authorize an\n IAM principal to work with Kubernetes objects on your cluster. The policies are\n managed by Amazon EKS, but they're not IAM policies. You can't\n view the permissions in the policies using the API. The permissions for many of the\n policies are similar to the Kubernetes cluster-admin, admin,\n edit, and view cluster roles. For more information about\n these cluster roles, see User-facing roles in the Kubernetes documentation. To view the contents of the\n policies, see Access\n policy permissions in the Amazon EKS User Guide.
The scope type of an access policy.
" - } - }, - "namespaces": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "A Kubernetes namespace that an access policy is scoped to. A value is required\n if you specified namespace for Type.
The scope of an AccessPolicy that's associated to an\n AccessEntry.
The name of the add-on.
" - } - }, - "clusterName": { - "target": "com.amazonaws.eks#ClusterName", - "traits": { - "smithy.api#documentation": "The name of your cluster.
" - } - }, - "status": { - "target": "com.amazonaws.eks#AddonStatus", - "traits": { - "smithy.api#documentation": "The status of the add-on.
" - } - }, - "addonVersion": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The version of the add-on.
" - } - }, - "health": { - "target": "com.amazonaws.eks#AddonHealth", - "traits": { - "smithy.api#documentation": "An object that represents the health of the add-on.
" - } - }, - "addonArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the add-on.
" - } - }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" - } - }, - "modifiedAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp for the last modification to the object.
" - } - }, - "serviceAccountRoleArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes\n ServiceAccount object that the add-on uses.
Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "publisher": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The publisher of the add-on.
" - } - }, - "owner": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The owner of the add-on.
" - } - }, - "marketplaceInformation": { - "target": "com.amazonaws.eks#MarketplaceInformation", - "traits": { - "smithy.api#documentation": "Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.
" - } - }, - "configurationValues": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The configuration values that you provided.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An Amazon EKS add-on. For more information, see Amazon EKS add-ons in\n the Amazon EKS User Guide.
" - } - }, - "com.amazonaws.eks#AddonHealth": { - "type": "structure", - "members": { - "issues": { - "target": "com.amazonaws.eks#AddonIssueList", - "traits": { - "smithy.api#documentation": "An object representing the health issues for an add-on.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The health of the add-on.
" - } - }, - "com.amazonaws.eks#AddonInfo": { - "type": "structure", - "members": { - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the add-on.
" - } - }, - "type": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The type of the add-on.
" - } - }, - "addonVersions": { - "target": "com.amazonaws.eks#AddonVersionInfoList", - "traits": { - "smithy.api#documentation": "An object representing information about available add-on versions and compatible\n Kubernetes versions.
" - } - }, - "publisher": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The publisher of the add-on.
" - } - }, - "owner": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The owner of the add-on.
" - } - }, - "marketplaceInformation": { - "target": "com.amazonaws.eks#MarketplaceInformation", - "traits": { - "smithy.api#documentation": "Information about the add-on from the Amazon Web Services Marketplace.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about an add-on.
" - } - }, - "com.amazonaws.eks#AddonIssue": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.eks#AddonIssueCode", - "traits": { - "smithy.api#documentation": "A code that describes the type of issue.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A message that provides details about the issue and what might cause it.
" - } - }, - "resourceIds": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The resource IDs of the issue.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An issue related to an add-on.
" - } - }, - "com.amazonaws.eks#AddonIssueCode": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessDenied" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalFailure" - } - }, - "CLUSTER_UNREACHABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClusterUnreachable" - } - }, - "INSUFFICIENT_NUMBER_OF_REPLICAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InsufficientNumberOfReplicas" - } - }, - "CONFIGURATION_CONFLICT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ConfigurationConflict" - } - }, - "ADMISSION_REQUEST_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AdmissionRequestDenied" - } - }, - "UNSUPPORTED_ADDON_MODIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnsupportedAddonModification" - } - }, - "K8S_RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "K8sResourceNotFound" - } - } - } - }, - "com.amazonaws.eks#AddonIssueList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#AddonIssue" - } - }, - "com.amazonaws.eks#AddonStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - }, - "DEGRADED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEGRADED" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - } - } - }, - "com.amazonaws.eks#AddonVersionInfo": { - "type": "structure", - "members": { - "addonVersion": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The version of the add-on.
" - } - }, - "architecture": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The architectures that the version supports.
" - } - }, - "compatibilities": { - "target": "com.amazonaws.eks#Compatibilities", - "traits": { - "smithy.api#documentation": "An object representing the compatibilities of a version.
" - } - }, - "requiresConfiguration": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Whether the add-on requires configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about an add-on version.
" - } - }, - "com.amazonaws.eks#AddonVersionInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#AddonVersionInfo" - } - }, - "com.amazonaws.eks#Addons": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#AddonInfo" - } - }, - "com.amazonaws.eks#AssociateAccessPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#AssociateAccessPolicyRequest" - }, - "output": { - "target": "com.amazonaws.eks#AssociateAccessPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Associates an access policy and its scope to an access entry. For more information\n about associating access policies, see Associating and disassociating\n access policies to and from access entries in the Amazon EKS User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies", - "code": 200 - } - } - }, - "com.amazonaws.eks#AssociateAccessPolicyRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM user or role for the AccessEntry\n that you're associating the access policy to.
The ARN of the AccessPolicy that you're associating. For a list of\n ARNs, use ListAccessPolicies.
The scope for the AccessPolicy. You can scope access policies to an\n entire cluster or to specific Kubernetes namespaces.
The name of your cluster.
" - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The AccessPolicy and scope associated to the\n AccessEntry.
Associates an encryption configuration to an existing cluster.
\nUse this API to enable encryption on existing clusters that don't already have\n encryption enabled. This allows you to implement a defense-in-depth security strategy\n without migrating applications to new Amazon EKS clusters.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/encryption-config/associate", - "code": 200 - } - } - }, - "com.amazonaws.eks#AssociateEncryptionConfigRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "encryptionConfig": { - "target": "com.amazonaws.eks#EncryptionConfigList", - "traits": { - "smithy.api#documentation": "The configuration you are using for encryption.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#AssociateEncryptionConfigResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#AssociateIdentityProviderConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#AssociateIdentityProviderConfigRequest" - }, - "output": { - "target": "com.amazonaws.eks#AssociateIdentityProviderConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Associates an identity provider configuration to a cluster.
\nIf you want to authenticate identities using an identity provider, you can create an\n identity provider configuration and associate it to your cluster. After configuring\n authentication to your cluster you can create Kubernetes Role and\n ClusterRole objects, assign permissions to them, and then bind them to\n the identities using Kubernetes RoleBinding and ClusterRoleBinding\n objects. For more information see Using RBAC\n Authorization in the Kubernetes documentation.
The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "oidc": { - "target": "com.amazonaws.eks#OidcIdentityProviderConfigRequest", - "traits": { - "smithy.api#documentation": "An object representing an OpenID Connect (OIDC) identity provider configuration.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#AssociateIdentityProviderConfigResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update" - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#AssociatedAccessPoliciesList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#AssociatedAccessPolicy" - } - }, - "com.amazonaws.eks#AssociatedAccessPolicy": { - "type": "structure", - "members": { - "policyArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the AccessPolicy.
The scope of the access policy.
" - } - }, - "associatedAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time the AccessPolicy was associated with an\n AccessEntry.
The Unix epoch timestamp for the last modification to the object.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An access policy association.
" - } - }, - "com.amazonaws.eks#AuthenticationMode": { - "type": "enum", - "members": { - "API": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "API" - } - }, - "API_AND_CONFIG_MAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "API_AND_CONFIG_MAP" - } - }, - "CONFIG_MAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFIG_MAP" - } - } - } - }, - "com.amazonaws.eks#AutoScalingGroup": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group associated with an Amazon EKS managed\n node group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An Auto Scaling group that is associated with an Amazon EKS managed node\n group.
" - } - }, - "com.amazonaws.eks#AutoScalingGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#AutoScalingGroup" - } - }, - "com.amazonaws.eks#BadRequestException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "This exception is thrown if the request contains a semantic error. The precise meaning\n will depend on the API, and will be documented in the error message.
" - } - } - }, - "traits": { - "smithy.api#documentation": "This exception is thrown if the request contains a semantic error. The precise meaning\n will depend on the API, and will be documented in the error message.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.eks#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.eks#BoxedBoolean": { - "type": "boolean" - }, - "com.amazonaws.eks#BoxedInteger": { - "type": "integer" - }, - "com.amazonaws.eks#Capacity": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.eks#CapacityTypes": { - "type": "enum", - "members": { - "ON_DEMAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ON_DEMAND" - } - }, - "SPOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPOT" - } - } - } - }, - "com.amazonaws.eks#Certificate": { - "type": "structure", - "members": { - "data": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Base64-encoded certificate data required to communicate with your cluster. Add\n this to the certificate-authority-data section of the\n kubeconfig file for your cluster.
An object representing the certificate-authority-data for your\n cluster.
The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" - } - }, - "subscriptionId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "These errors are usually caused by a client action. Actions can include using an\n action or resource on behalf of an IAM principal that doesn't have permissions to use\n the action or resource or specifying an identifier that is not valid.
" - } - } - }, - "traits": { - "smithy.api#documentation": "These errors are usually caused by a client action. Actions can include using an\n action or resource on behalf of an IAM principal that doesn't have permissions to use\n the action or resource or specifying an identifier that is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.eks#Cluster": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
" - } - }, - "arn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
" - } - }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" - } - }, - "version": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Kubernetes server version for the cluster.
" - } - }, - "endpoint": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The endpoint for your Kubernetes API server.
" - } - }, - "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\n control plane to make calls to Amazon Web Services API operations on your behalf.
" - } - }, - "resourcesVpcConfig": { - "target": "com.amazonaws.eks#VpcConfigResponse", - "traits": { - "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 information,\n see Cluster VPC\n considerations and Cluster security group considerations in the\n Amazon EKS User Guide.
" - } - }, - "kubernetesNetworkConfig": { - "target": "com.amazonaws.eks#KubernetesNetworkConfigResponse", - "traits": { - "smithy.api#documentation": "The Kubernetes network configuration for the cluster.
" - } - }, - "logging": { - "target": "com.amazonaws.eks#Logging", - "traits": { - "smithy.api#documentation": "The logging configuration for your cluster.
" - } - }, - "identity": { - "target": "com.amazonaws.eks#Identity", - "traits": { - "smithy.api#documentation": "The identity provider information for the cluster.
" - } - }, - "status": { - "target": "com.amazonaws.eks#ClusterStatus", - "traits": { - "smithy.api#documentation": "The current status of the cluster.
" - } - }, - "certificateAuthority": { - "target": "com.amazonaws.eks#Certificate", - "traits": { - "smithy.api#documentation": "The certificate-authority-data for your cluster.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
" - } - }, - "platformVersion": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The platform version of your Amazon EKS cluster. For more information about\n clusters deployed on the Amazon Web Services Cloud, see Platform\n versions in the \n Amazon EKS User Guide\n . For more information\n about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the\n \n Amazon EKS User Guide\n .
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "encryptionConfig": { - "target": "com.amazonaws.eks#EncryptionConfigList", - "traits": { - "smithy.api#documentation": "The encryption configuration for the cluster.
" - } - }, - "connectorConfig": { - "target": "com.amazonaws.eks#ConnectorConfigResponse", - "traits": { - "smithy.api#documentation": "The configuration used to connect to a cluster for registration.
" - } - }, - "id": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This\n property isn't available for an Amazon EKS cluster on the Amazon Web Services\n cloud.
" - } - }, - "health": { - "target": "com.amazonaws.eks#ClusterHealth", - "traits": { - "smithy.api#documentation": "An object representing the health of your local Amazon EKS cluster on an\n Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
" - } - }, - "outpostConfig": { - "target": "com.amazonaws.eks#OutpostConfigResponse", - "traits": { - "smithy.api#documentation": "An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
" - } - }, - "accessConfig": { - "target": "com.amazonaws.eks#AccessConfigResponse", - "traits": { - "smithy.api#documentation": "The access configuration for the cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an Amazon EKS cluster.
" - } - }, - "com.amazonaws.eks#ClusterHealth": { - "type": "structure", - "members": { - "issues": { - "target": "com.amazonaws.eks#ClusterIssueList", - "traits": { - "smithy.api#documentation": "An object representing the health issues of your local Amazon EKS cluster on\n an Amazon Web Services Outpost.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the health of your local Amazon EKS cluster on an\n Amazon Web Services Outpost. You can't use this API with an Amazon EKS\n cluster on the Amazon Web Services cloud.
" - } - }, - "com.amazonaws.eks#ClusterIssue": { - "type": "structure", - "members": { - "code": { - "target": "com.amazonaws.eks#ClusterIssueCode", - "traits": { - "smithy.api#documentation": "The error code of the issue.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A description of the issue.
" - } - }, - "resourceIds": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The resource IDs that the issue relates to.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost.\n You can't use this API with an Amazon EKS cluster on the Amazon Web Services\n cloud.
" - } - }, - "com.amazonaws.eks#ClusterIssueCode": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessDenied" - } - }, - "CLUSTER_UNREACHABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClusterUnreachable" - } - }, - "CONFIGURATION_CONFLICT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ConfigurationConflict" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalFailure" - } - }, - "RESOURCE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceLimitExceeded" - } - }, - "RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceNotFound" - } - }, - "IAM_ROLE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IamRoleNotFound" - } - }, - "VPC_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VpcNotFound" - } - }, - "INSUFFICIENT_FREE_ADDRESSES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InsufficientFreeAddresses" - } - }, - "EC2_SERVICE_NOT_SUBSCRIBED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2ServiceNotSubscribed" - } - }, - "EC2_SUBNET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SubnetNotFound" - } - }, - "EC2_SECURITY_GROUP_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SecurityGroupNotFound" - } - }, - "KMS_GRANT_REVOKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KmsGrantRevoked" - } - }, - "KMS_KEY_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KmsKeyNotFound" - } - }, - "KMS_KEY_MARKED_FOR_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KmsKeyMarkedForDeletion" - } - }, - "KMS_KEY_DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KmsKeyDisabled" - } - }, - "STS_REGIONAL_ENDPOINT_DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StsRegionalEndpointDisabled" - } - }, - "UNSUPPORTED_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnsupportedVersion" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Other" - } - } - } - }, - "com.amazonaws.eks#ClusterIssueList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#ClusterIssue" - } - }, - "com.amazonaws.eks#ClusterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" - } - }, - "com.amazonaws.eks#ClusterStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - } - } - }, - "com.amazonaws.eks#Compatibilities": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#Compatibility" - } - }, - "com.amazonaws.eks#Compatibility": { - "type": "structure", - "members": { - "clusterVersion": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The supported Kubernetes version of the cluster.
" - } - }, - "platformVersions": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The supported compute platform.
" - } - }, - "defaultVersion": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "The supported default version.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Compatibility information.
" - } - }, - "com.amazonaws.eks#ConnectorConfigProvider": { - "type": "enum", - "members": { - "EKS_ANYWHERE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_ANYWHERE" - } - }, - "ANTHOS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANTHOS" - } - }, - "GKE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GKE" - } - }, - "AKS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AKS" - } - }, - "OPENSHIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPENSHIFT" - } - }, - "TANZU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TANZU" - } - }, - "RANCHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANCHER" - } - }, - "EC2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - } - } - }, - "com.amazonaws.eks#ConnectorConfigRequest": { - "type": "structure", - "members": { - "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\n configuration.
", - "smithy.api#required": {} - } - }, - "provider": { - "target": "com.amazonaws.eks#ConnectorConfigProvider", - "traits": { - "smithy.api#documentation": "The cloud provider for the target cluster to connect.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration sent to a cluster for configuration.
" - } - }, - "com.amazonaws.eks#ConnectorConfigResponse": { - "type": "structure", - "members": { - "activationId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique ID associated with the cluster for registration purposes.
" - } - }, - "activationCode": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique code associated with the cluster for registration purposes.
" - } - }, - "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\n through the native provider.
" - } - }, - "provider": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The cluster's cloud service provider.
" - } - }, - "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\n cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The full description of your connected cluster.
" - } - }, - "com.amazonaws.eks#ControlPlanePlacementRequest": { - "type": "structure", - "members": { - "groupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the placement group for the Kubernetes control plane instances. This setting\n can't be changed after cluster creation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see\n Capacity\n considerations in the Amazon EKS User Guide.
" - } - }, - "com.amazonaws.eks#ControlPlanePlacementResponse": { - "type": "structure", - "members": { - "groupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the placement group for the Kubernetes control plane instances.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see\n Capacity considerations in the Amazon EKS User Guide.
" - } - }, - "com.amazonaws.eks#CreateAccessConfigRequest": { - "type": "structure", - "members": { - "bootstrapClusterCreatorAdminPermissions": { - "target": "com.amazonaws.eks#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Specifies whether or not the cluster creator IAM principal was set as a\n cluster admin access entry during cluster creation time. The default value is\n true.
The desired authentication mode for the cluster. If you create a cluster by using the\n EKS API, Amazon Web Services SDKs, or CloudFormation, the default is CONFIG_MAP. If you create\n the cluster by using the Amazon Web Services Management Console, the default value is\n API_AND_CONFIG_MAP.
The access configuration information for the cluster.
" - } - }, - "com.amazonaws.eks#CreateAccessEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#CreateAccessEntryRequest" - }, - "output": { - "target": "com.amazonaws.eks#CreateAccessEntryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an access entry.
\nAn access entry allows an IAM principal to access your cluster. Access\n entries can replace the need to maintain entries in the aws-auth\n ConfigMap for authentication. You have the following options for\n authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes\n role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization\n requires you to create and manage Kubernetes Role, ClusterRole,\n RoleBinding, and ClusterRoleBinding objects, in addition\n to managing access entries. If you use Amazon EKS authorization exclusively, you\n don't need to create and manage Kubernetes Role, ClusterRole,\n RoleBinding, and ClusterRoleBinding objects.
For more information about access entries, see Access entries in the\n Amazon EKS User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/access-entries", - "code": 200 - } - } - }, - "com.amazonaws.eks#CreateAccessEntryRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry. You can specify one ARN for each access entry. You can't specify the\n same ARN in more than one access entry. This value can't be changed after access entry\n creation.
\n IAM best practices recommend using IAM roles with\n temporary credentials, rather than IAM users with long-term credentials.\n
", - "smithy.api#required": {} - } - }, - "kubernetesGroups": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The value for name that you've specified for kind: Group as\n a subject in a Kubernetes RoleBinding or\n ClusterRoleBinding object. Amazon EKS doesn't confirm that the\n value for name exists in any bindings on your cluster. You can specify one\n or more names.
Kubernetes authorizes the principalArn of the access entry to access any\n cluster objects that you've specified in a Kubernetes Role or\n ClusterRole object that is also specified in a binding's\n roleRef. For more information about creating Kubernetes\n RoleBinding, ClusterRoleBinding, Role, or\n ClusterRole objects, see Using RBAC\n Authorization in the Kubernetes documentation.
If you want Amazon EKS to authorize the principalArn (instead of,\n or in addition to Kubernetes authorizing the principalArn), you can associate\n one or more access policies to the access entry using\n AssociateAccessPolicy. If you associate any access policies, the\n principalARN has all permissions assigned in the associated access\n policies and all permissions in any Kubernetes Role or ClusterRole\n objects that the group names are bound to.
Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "username": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The username to authenticate to Kubernetes with. We recommend not specifying a username and\n letting Amazon EKS specify it for you. For more information about the value\n Amazon EKS specifies for you, or constraints before specifying your own\n username, see Creating\n access entries in the Amazon EKS User Guide.
" - } - }, - "type": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "If the principalArn is for an IAM role that's used for\n self-managed Amazon EC2 nodes, specify EC2_LINUX or\n EC2_WINDOWS. Amazon EKS grants the necessary permissions to the\n node for you. If the principalArn is for any other purpose, specify\n STANDARD. If you don't specify a value, Amazon EKS sets the\n value to STANDARD. It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the\n aws-auth\n ConfigMap for the roles. You can't change this value once you've created\n the access entry.
If you set the value to EC2_LINUX or EC2_WINDOWS, you can't\n specify values for kubernetesGroups, or associate an\n AccessPolicy to the access entry.
Creates an Amazon EKS add-on.
\nAmazon EKS add-ons help to automate the provisioning and lifecycle management\n of common operational software for Amazon EKS clusters. For more information,\n see Amazon EKS add-ons in the Amazon EKS User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/addons", - "code": 200 - } - } - }, - "com.amazonaws.eks#CreateAddonRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#ClusterName", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by\n DescribeAddonVersions.
The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.
\nTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.
\nHow to resolve field value conflicts for an Amazon EKS add-on. Conflicts are\n handled based on the value you choose:
\n\n None – If the self-managed version of\n the add-on is installed on your cluster, Amazon EKS doesn't change the\n value. Creation of the add-on might fail.
\n\n Overwrite – If the self-managed\n version of the add-on is installed on your cluster and the Amazon EKS\n default value is different than the existing value, Amazon EKS changes\n the value to the Amazon EKS default value.
\n\n Preserve – This is similar to the NONE\n option. If the self-managed version of the add-on is installed on your cluster\n Amazon EKS doesn't change the add-on resource properties. Creation\n of the add-on might fail if conflicts are detected. This option works\n differently during the update operation. For more information, see UpdateAddon.
\nIf you don't currently have the self-managed version of the add-on installed on your\n cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values\n to default values, regardless of the option that you specify.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "configurationValues": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.
Creates an Amazon EKS control plane.
\nThe Amazon EKS control plane consists of control plane instances that run the\n Kubernetes software, such as etcd and the API server. The control plane runs in\n an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is\n single tenant and unique. It runs on its own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in\n your VPC subnets to provide connectivity from the control plane instances to the nodes\n (for example, to support kubectl exec, logs, and\n proxy data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your\n cluster's control plane over the Kubernetes API server endpoint and a certificate file that\n is created for your cluster.
\nYou can use the endpointPublicAccess and\n endpointPrivateAccess parameters to enable or disable public and\n private access to your cluster's Kubernetes API server endpoint. By default, public access is\n enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .
You can use the logging parameter to enable or disable exporting the\n Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster\n control plane logs aren't exported to CloudWatch Logs. For more information, see\n Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.
\nIn most cases, it takes several minutes to create a cluster. After you create an\n Amazon EKS cluster, you must configure your Kubernetes tooling to communicate\n with the API server and launch 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#examples": [ - { - "title": "To create a new cluster", - "documentation": "The following example creates an Amazon EKS cluster called prod.", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://fips.eks.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://eks.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://eks-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.eks#AccessConfigResponse": { + "type": "structure", + "members": { + "bootstrapClusterCreatorAdminPermissions": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Specifies whether or not the cluster creator IAM principal was set as a\n cluster admin access entry during cluster creation time.
" + } + }, + "authenticationMode": { + "target": "com.amazonaws.eks#AuthenticationMode", + "traits": { + "smithy.api#documentation": "The current authentication mode of the cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The access configuration for the cluster.
" + } + }, + "com.amazonaws.eks#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You don't have permissions to perform the requested operation. The IAM principal\n making the request must have at least one IAM permissions policy attached\n that grants the required permissions. For more information, see Access\n management in the IAM User Guide.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.eks#AccessEntry": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
" + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the access entry. If you ever delete\n the IAM principal with this ARN, the access entry isn't automatically\n deleted. We recommend that you delete the access entry with an ARN for an IAM principal that you delete. If you don't delete the access entry and ever\n recreate the IAM principal, even if it has the same ARN, the access\n entry won't work. This is because even though the ARN is the same for the recreated\n IAM principal, the roleID or userID (you\n can see this with the Security Token Service\n GetCallerIdentity API) is different for the recreated IAM\n principal than it was for the original IAM principal. Even though you\n don't see the IAM principal's roleID or userID\n for an access entry, Amazon EKS stores it with the access entry.
A name that you've specified in a Kubernetes RoleBinding or\n ClusterRoleBinding object so that Kubernetes authorizes the\n principalARN access to cluster objects.
The ARN of the access entry.
" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp for the last modification to the object.
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "username": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of a user that can authenticate to your cluster.
The type of the access entry.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An access entry allows an IAM principal (user or role) to access your\n cluster. Access entries can replace the need to maintain the aws-auth\n ConfigMap for authentication. For more information about access entries,\n see Access\n entries in the Amazon EKS User Guide.
The name of the access policy.
" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the access policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An access policy includes permissions that allow Amazon EKS to authorize an\n IAM principal to work with Kubernetes objects on your cluster. The policies are\n managed by Amazon EKS, but they're not IAM policies. You can't\n view the permissions in the policies using the API. The permissions for many of the\n policies are similar to the Kubernetes cluster-admin, admin,\n edit, and view cluster roles. For more information about\n these cluster roles, see User-facing roles in the Kubernetes documentation. To view the contents of the\n policies, see Access\n policy permissions in the Amazon EKS User Guide.
The scope type of an access policy.
" + } + }, + "namespaces": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "A Kubernetes namespace that an access policy is scoped to. A value is required\n if you specified namespace for Type.
The scope of an AccessPolicy that's associated to an\n AccessEntry.
The name of the add-on.
" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "The name of your cluster.
" + } + }, + "status": { + "target": "com.amazonaws.eks#AddonStatus", + "traits": { + "smithy.api#documentation": "The status of the add-on.
" + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The version of the add-on.
" + } + }, + "health": { + "target": "com.amazonaws.eks#AddonHealth", + "traits": { + "smithy.api#documentation": "An object that represents the health of the add-on.
" + } + }, + "addonArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the add-on.
" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp for the last modification to the object.
" + } + }, + "serviceAccountRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that's bound to the Kubernetes\n ServiceAccount object that the add-on uses.
Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "publisher": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The publisher of the add-on.
" + } + }, + "owner": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The owner of the add-on.
" + } + }, + "marketplaceInformation": { + "target": "com.amazonaws.eks#MarketplaceInformation", + "traits": { + "smithy.api#documentation": "Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.
" + } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The configuration values that you provided.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon EKS add-on. For more information, see Amazon EKS add-ons in\n the Amazon EKS User Guide.
" + } + }, + "com.amazonaws.eks#AddonHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#AddonIssueList", + "traits": { + "smithy.api#documentation": "An object representing the health issues for an add-on.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The health of the add-on.
" + } + }, + "com.amazonaws.eks#AddonInfo": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the add-on.
" + } + }, + "type": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The type of the add-on.
" + } + }, + "addonVersions": { + "target": "com.amazonaws.eks#AddonVersionInfoList", + "traits": { + "smithy.api#documentation": "An object representing information about available add-on versions and compatible\n Kubernetes versions.
" + } + }, + "publisher": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The publisher of the add-on.
" + } + }, + "owner": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The owner of the add-on.
" + } + }, + "marketplaceInformation": { + "target": "com.amazonaws.eks#MarketplaceInformation", + "traits": { + "smithy.api#documentation": "Information about the add-on from the Amazon Web Services Marketplace.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an add-on.
" + } + }, + "com.amazonaws.eks#AddonIssue": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.eks#AddonIssueCode", + "traits": { + "smithy.api#documentation": "A code that describes the type of issue.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A message that provides details about the issue and what might cause it.
" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The resource IDs of the issue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An issue related to an add-on.
" + } + }, + "com.amazonaws.eks#AddonIssueCode": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "INSUFFICIENT_NUMBER_OF_REPLICAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientNumberOfReplicas" + } + }, + "CONFIGURATION_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationConflict" + } + }, + "ADMISSION_REQUEST_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdmissionRequestDenied" + } + }, + "UNSUPPORTED_ADDON_MODIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedAddonModification" + } + }, + "K8S_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "K8sResourceNotFound" + } + } + } + }, + "com.amazonaws.eks#AddonIssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonIssue" + } + }, + "com.amazonaws.eks#AddonStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "DEGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEGRADED" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + } + } + }, + "com.amazonaws.eks#AddonVersionInfo": { + "type": "structure", + "members": { + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The version of the add-on.
" + } + }, + "architecture": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The architectures that the version supports.
" + } + }, + "compatibilities": { + "target": "com.amazonaws.eks#Compatibilities", + "traits": { + "smithy.api#documentation": "An object representing the compatibilities of a version.
" + } + }, + "requiresConfiguration": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether the add-on requires configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an add-on version.
" + } + }, + "com.amazonaws.eks#AddonVersionInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonVersionInfo" + } + }, + "com.amazonaws.eks#Addons": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AddonInfo" + } + }, + "com.amazonaws.eks#AssociateAccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#AssociateAccessPolicyRequest" + }, + "output": { + "target": "com.amazonaws.eks#AssociateAccessPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Associates an access policy and its scope to an access entry. For more information\n about associating access policies, see Associating and disassociating\n access policies to and from access entries in the Amazon EKS User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies", + "code": 200 + } + } + }, + "com.amazonaws.eks#AssociateAccessPolicyRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM user or role for the AccessEntry\n that you're associating the access policy to.
The ARN of the AccessPolicy that you're associating. For a list of\n ARNs, use ListAccessPolicies.
The scope for the AccessPolicy. You can scope access policies to an\n entire cluster or to specific Kubernetes namespaces.
The name of your cluster.
" + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The AccessPolicy and scope associated to the\n AccessEntry.
Associates an encryption configuration to an existing cluster.
\nUse this API to enable encryption on existing clusters that don't already have\n encryption enabled. This allows you to implement a defense-in-depth security strategy\n without migrating applications to new Amazon EKS clusters.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/encryption-config/associate", + "code": 200 + } + } + }, + "com.amazonaws.eks#AssociateEncryptionConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", + "traits": { + "smithy.api#documentation": "The configuration you are using for encryption.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#AssociateEncryptionConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#AssociateIdentityProviderConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#AssociateIdentityProviderConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#AssociateIdentityProviderConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Associates an identity provider configuration to a cluster.
\nIf you want to authenticate identities using an identity provider, you can create an\n identity provider configuration and associate it to your cluster. After configuring\n authentication to your cluster you can create Kubernetes Role and\n ClusterRole objects, assign permissions to them, and then bind them to\n the identities using Kubernetes RoleBinding and ClusterRoleBinding\n objects. For more information see Using RBAC\n Authorization in the Kubernetes documentation.
The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "oidc": { + "target": "com.amazonaws.eks#OidcIdentityProviderConfigRequest", + "traits": { + "smithy.api#documentation": "An object representing an OpenID Connect (OIDC) identity provider configuration.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#AssociateIdentityProviderConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#AssociatedAccessPoliciesList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AssociatedAccessPolicy" + } + }, + "com.amazonaws.eks#AssociatedAccessPolicy": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the AccessPolicy.
The scope of the access policy.
" + } + }, + "associatedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the AccessPolicy was associated with an\n AccessEntry.
The Unix epoch timestamp for the last modification to the object.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An access policy association.
" + } + }, + "com.amazonaws.eks#AuthenticationMode": { + "type": "enum", + "members": { + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API" + } + }, + "API_AND_CONFIG_MAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "API_AND_CONFIG_MAP" + } + }, + "CONFIG_MAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFIG_MAP" + } + } + } + }, + "com.amazonaws.eks#AutoScalingGroup": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Auto Scaling group associated with an Amazon EKS managed\n node group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Auto Scaling group that is associated with an Amazon EKS managed node\n group.
" + } + }, + "com.amazonaws.eks#AutoScalingGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#AutoScalingGroup" + } + }, + "com.amazonaws.eks#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "This exception is thrown if the request contains a semantic error. The precise meaning\n will depend on the API, and will be documented in the error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "This exception is thrown if the request contains a semantic error. The precise meaning\n will depend on the API, and will be documented in the error message.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.eks#BoxedBoolean": { + "type": "boolean" + }, + "com.amazonaws.eks#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.eks#Capacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.eks#CapacityTypes": { + "type": "enum", + "members": { + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + }, + "SPOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPOT" + } + } + } + }, + "com.amazonaws.eks#Category": { + "type": "enum", + "members": { + "UPGRADE_READINESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPGRADE_READINESS" + } + } + } + }, + "com.amazonaws.eks#CategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Category" + } + }, + "com.amazonaws.eks#Certificate": { + "type": "structure", + "members": { + "data": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Base64-encoded certificate data required to communicate with your cluster. Add\n this to the certificate-authority-data section of the\n kubeconfig file for your cluster.
An object representing the certificate-authority-data for your\n cluster.
The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "These errors are usually caused by a client action. Actions can include using an\n action or resource on behalf of an IAM principal that doesn't have permissions to use\n the action or resource or specifying an identifier that is not valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "These errors are usually caused by a client action. Actions can include using an\n action or resource on behalf of an IAM principal that doesn't have permissions to use\n the action or resource or specifying an identifier that is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#ClientStat": { + "type": "structure", + "members": { + "userAgent": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The user agent of the Kubernetes client using the deprecated resource.
" + } + }, + "numberOfRequestsLast30Days": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of requests from the Kubernetes client seen over the last 30 days.
" + } + }, + "lastRequestTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last request seen from the Kubernetes client.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about clients using the deprecated resources.
" + } + }, + "com.amazonaws.eks#ClientStats": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#ClientStat" + } + }, + "com.amazonaws.eks#Cluster": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes server version for the cluster.
" + } + }, + "endpoint": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The endpoint for your Kubernetes API server.
" + } + }, + "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\n control plane to make calls to Amazon Web Services API operations on your behalf.
" + } + }, + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigResponse", + "traits": { + "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 information,\n see Cluster VPC\n considerations and Cluster security group considerations in the\n Amazon EKS User Guide.
" + } + }, + "kubernetesNetworkConfig": { + "target": "com.amazonaws.eks#KubernetesNetworkConfigResponse", + "traits": { + "smithy.api#documentation": "The Kubernetes network configuration for the cluster.
" + } + }, + "logging": { + "target": "com.amazonaws.eks#Logging", + "traits": { + "smithy.api#documentation": "The logging configuration for your cluster.
" + } + }, + "identity": { + "target": "com.amazonaws.eks#Identity", + "traits": { + "smithy.api#documentation": "The identity provider information for the cluster.
" + } + }, + "status": { + "target": "com.amazonaws.eks#ClusterStatus", + "traits": { + "smithy.api#documentation": "The current status of the cluster.
" + } + }, + "certificateAuthority": { + "target": "com.amazonaws.eks#Certificate", + "traits": { + "smithy.api#documentation": "The certificate-authority-data for your cluster.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The platform version of your Amazon EKS cluster. For more information about\n clusters deployed on the Amazon Web Services Cloud, see Platform\n versions in the \n Amazon EKS User Guide\n . For more information\n about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the\n \n Amazon EKS User Guide\n .
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", + "traits": { + "smithy.api#documentation": "The encryption configuration for the cluster.
" + } + }, + "connectorConfig": { + "target": "com.amazonaws.eks#ConnectorConfigResponse", + "traits": { + "smithy.api#documentation": "The configuration used to connect to a cluster for registration.
" + } + }, + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This\n property isn't available for an Amazon EKS cluster on the Amazon Web Services\n cloud.
" + } + }, + "health": { + "target": "com.amazonaws.eks#ClusterHealth", + "traits": { + "smithy.api#documentation": "An object representing the health of your local Amazon EKS cluster on an\n Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
" + } + }, + "outpostConfig": { + "target": "com.amazonaws.eks#OutpostConfigResponse", + "traits": { + "smithy.api#documentation": "An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
" + } + }, + "accessConfig": { + "target": "com.amazonaws.eks#AccessConfigResponse", + "traits": { + "smithy.api#documentation": "The access configuration for the cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an Amazon EKS cluster.
" + } + }, + "com.amazonaws.eks#ClusterHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#ClusterIssueList", + "traits": { + "smithy.api#documentation": "An object representing the health issues of your local Amazon EKS cluster on\n an Amazon Web Services Outpost.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the health of your local Amazon EKS cluster on an\n Amazon Web Services Outpost. You can't use this API with an Amazon EKS\n cluster on the Amazon Web Services cloud.
" + } + }, + "com.amazonaws.eks#ClusterIssue": { + "type": "structure", + "members": { + "code": { + "target": "com.amazonaws.eks#ClusterIssueCode", + "traits": { + "smithy.api#documentation": "The error code of the issue.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A description of the issue.
" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The resource IDs that the issue relates to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost.\n You can't use this API with an Amazon EKS cluster on the Amazon Web Services\n cloud.
" + } + }, + "com.amazonaws.eks#ClusterIssueCode": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "CONFIGURATION_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationConflict" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + }, + "RESOURCE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceLimitExceeded" + } + }, + "RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceNotFound" + } + }, + "IAM_ROLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamRoleNotFound" + } + }, + "VPC_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcNotFound" + } + }, + "INSUFFICIENT_FREE_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientFreeAddresses" + } + }, + "EC2_SERVICE_NOT_SUBSCRIBED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2ServiceNotSubscribed" + } + }, + "EC2_SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetNotFound" + } + }, + "EC2_SECURITY_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SecurityGroupNotFound" + } + }, + "KMS_GRANT_REVOKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsGrantRevoked" + } + }, + "KMS_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsKeyNotFound" + } + }, + "KMS_KEY_MARKED_FOR_DELETION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsKeyMarkedForDeletion" + } + }, + "KMS_KEY_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsKeyDisabled" + } + }, + "STS_REGIONAL_ENDPOINT_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StsRegionalEndpointDisabled" + } + }, + "UNSUPPORTED_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedVersion" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Other" + } + } + } + }, + "com.amazonaws.eks#ClusterIssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#ClusterIssue" + } + }, + "com.amazonaws.eks#ClusterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.eks#ClusterStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + } + } + }, + "com.amazonaws.eks#Compatibilities": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Compatibility" + } + }, + "com.amazonaws.eks#Compatibility": { + "type": "structure", + "members": { + "clusterVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The supported Kubernetes version of the cluster.
" + } + }, + "platformVersions": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The supported compute platform.
" + } + }, + "defaultVersion": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "The supported default version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Compatibility information.
" + } + }, + "com.amazonaws.eks#ConnectorConfigProvider": { + "type": "enum", + "members": { + "EKS_ANYWHERE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_ANYWHERE" + } + }, + "ANTHOS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANTHOS" + } + }, + "GKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GKE" + } + }, + "AKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AKS" + } + }, + "OPENSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPENSHIFT" + } + }, + "TANZU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TANZU" + } + }, + "RANCHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANCHER" + } + }, + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.eks#ConnectorConfigRequest": { + "type": "structure", + "members": { + "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\n configuration.
", + "smithy.api#required": {} + } + }, + "provider": { + "target": "com.amazonaws.eks#ConnectorConfigProvider", + "traits": { + "smithy.api#documentation": "The cloud provider for the target cluster to connect.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration sent to a cluster for configuration.
" + } + }, + "com.amazonaws.eks#ConnectorConfigResponse": { + "type": "structure", + "members": { + "activationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique ID associated with the cluster for registration purposes.
" + } + }, + "activationCode": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique code associated with the cluster for registration purposes.
" + } + }, + "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\n through the native provider.
" + } + }, + "provider": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The cluster's cloud service provider.
" + } + }, + "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\n cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The full description of your connected cluster.
" + } + }, + "com.amazonaws.eks#ControlPlanePlacementRequest": { + "type": "structure", + "members": { + "groupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the placement group for the Kubernetes control plane instances. This\n setting can't be changed after cluster creation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see\n Capacity\n considerations in the Amazon EKS User Guide.
" + } + }, + "com.amazonaws.eks#ControlPlanePlacementResponse": { + "type": "structure", + "members": { + "groupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the placement group for the Kubernetes control plane instances.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see\n Capacity considerations in the Amazon EKS User Guide.
" + } + }, + "com.amazonaws.eks#CreateAccessConfigRequest": { + "type": "structure", + "members": { + "bootstrapClusterCreatorAdminPermissions": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Specifies whether or not the cluster creator IAM principal was set as a\n cluster admin access entry during cluster creation time. The default value is\n true.
The desired authentication mode for the cluster. If you create a cluster by using the\n EKS API, Amazon Web Services SDKs, or CloudFormation, the default is CONFIG_MAP. If you create\n the cluster by using the Amazon Web Services Management Console, the default value is\n API_AND_CONFIG_MAP.
The access configuration information for the cluster.
" + } + }, + "com.amazonaws.eks#CreateAccessEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateAccessEntryRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateAccessEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an access entry.
\nAn access entry allows an IAM principal to access your cluster. Access\n entries can replace the need to maintain entries in the aws-auth\n ConfigMap for authentication. You have the following options for\n authorizing an IAM principal to access Kubernetes objects on your cluster: Kubernetes\n role-based access control (RBAC), Amazon EKS, or both. Kubernetes RBAC authorization\n requires you to create and manage Kubernetes Role, ClusterRole,\n RoleBinding, and ClusterRoleBinding objects, in addition\n to managing access entries. If you use Amazon EKS authorization exclusively, you\n don't need to create and manage Kubernetes Role, ClusterRole,\n RoleBinding, and ClusterRoleBinding objects.
For more information about access entries, see Access entries in the\n Amazon EKS User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/access-entries", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateAccessEntryRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry. You can specify one ARN for each access entry. You can't specify the\n same ARN in more than one access entry. This value can't be changed after access entry\n creation.
The valid principals differ depending on the type of the access entry in the type field.\n The only valid ARN is IAM roles for the types of access entries for nodes: \n . You can use every IAM principal type for STANDARD access entries.\n You can't use the STS session principal type with access entries because this is a temporary\n principal for each session and not a permanent identity that can be assigned permissions.
\n IAM best practices recommend using IAM roles with\n temporary credentials, rather than IAM users with long-term credentials.\n
", + "smithy.api#required": {} + } + }, + "kubernetesGroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The value for name that you've specified for kind: Group as\n a subject in a Kubernetes RoleBinding or\n ClusterRoleBinding object. Amazon EKS doesn't confirm that the\n value for name exists in any bindings on your cluster. You can specify one\n or more names.
Kubernetes authorizes the principalArn of the access entry to access any\n cluster objects that you've specified in a Kubernetes Role or\n ClusterRole object that is also specified in a binding's\n roleRef. For more information about creating Kubernetes\n RoleBinding, ClusterRoleBinding, Role, or\n ClusterRole objects, see Using RBAC\n Authorization in the Kubernetes documentation.
If you want Amazon EKS to authorize the principalArn (instead of,\n or in addition to Kubernetes authorizing the principalArn), you can associate\n one or more access policies to the access entry using\n AssociateAccessPolicy. If you associate any access policies, the\n principalARN has all permissions assigned in the associated access\n policies and all permissions in any Kubernetes Role or ClusterRole\n objects that the group names are bound to.
Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "username": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The username to authenticate to Kubernetes with. We recommend not specifying a username and\n letting Amazon EKS specify it for you. For more information about the value\n Amazon EKS specifies for you, or constraints before specifying your own\n username, see Creating\n access entries in the Amazon EKS User Guide.
" + } + }, + "type": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The type of the new access entry. Valid values are Standard,\n FARGATE_LINUX, EC2_LINUX, and EC2_WINDOWS.
If the principalArn is for an IAM role that's used for\n self-managed Amazon EC2 nodes, specify EC2_LINUX or\n EC2_WINDOWS. Amazon EKS grants the necessary permissions to the\n node for you. If the principalArn is for any other purpose, specify\n STANDARD. If you don't specify a value, Amazon EKS sets the\n value to STANDARD. It's unnecessary to create access entries for IAM roles used with Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates entries in the\n aws-auth\n ConfigMap for the roles. You can't change this value once you've created\n the access entry.
If you set the value to EC2_LINUX or EC2_WINDOWS, you can't\n specify values for kubernetesGroups, or associate an\n AccessPolicy to the access entry.
Creates an Amazon EKS add-on.
\nAmazon EKS add-ons help to automate the provisioning and lifecycle management\n of common operational software for Amazon EKS clusters. For more information,\n see Amazon EKS add-ons in the Amazon EKS User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/addons", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by\n DescribeAddonVersions.
The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.
\nTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.
\nHow to resolve field value conflicts for an Amazon EKS add-on. Conflicts are\n handled based on the value you choose:
\n\n None – If the self-managed version of\n the add-on is installed on your cluster, Amazon EKS doesn't change the\n value. Creation of the add-on might fail.
\n\n Overwrite – If the self-managed\n version of the add-on is installed on your cluster and the Amazon EKS\n default value is different than the existing value, Amazon EKS changes\n the value to the Amazon EKS default value.
\n\n Preserve – This is similar to the NONE\n option. If the self-managed version of the add-on is installed on your cluster\n Amazon EKS doesn't change the add-on resource properties. Creation\n of the add-on might fail if conflicts are detected. This option works\n differently during the update operation. For more information, see UpdateAddon.
\nIf you don't currently have the self-managed version of the add-on installed on your\n cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values\n to default values, regardless of the option that you specify.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.
Creates an Amazon EKS control plane.
\nThe Amazon EKS control plane consists of control plane instances that run the\n Kubernetes software, such as etcd and the API server. The control plane runs in\n an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is\n single tenant and unique. It runs on its own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing\n Network Load Balancer. Amazon EKS also provisions elastic network interfaces in\n your VPC subnets to provide connectivity from the control plane instances to the nodes\n (for example, to support kubectl exec, logs, and\n proxy data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your\n cluster's control plane over the Kubernetes API server endpoint and a certificate file that\n is created for your cluster.
\nYou can use the endpointPublicAccess and\n endpointPrivateAccess parameters to enable or disable public and\n private access to your cluster's Kubernetes API server endpoint. By default, public access is\n enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the\n \n Amazon EKS User Guide\n .
You can use the logging parameter to enable or disable exporting the\n Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster\n control plane logs aren't exported to CloudWatch Logs. For more information, see\n Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.
\nIn most cases, it takes several minutes to create a cluster. After you create an\n Amazon EKS cluster, you must configure your Kubernetes tooling to communicate\n with the API server and launch 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#examples": [ + { + "title": "To create a new cluster", + "documentation": "The following example creates an Amazon EKS cluster called prod.", + "input": { + "name": "prod", + "version": "1.10", + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "securityGroupIds": [ + "sg-6979fe18" + ] + }, + "clientRequestToken": "1d2129a1-3d38-460a-9756-e5b91fddb951" + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/clusters", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "The unique name to give to your cluster.
", + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The desired Kubernetes version for your cluster. If you don't specify a value here, the\n default version available in Amazon EKS is used.
\nThe default version might not be the latest version available.
\nThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes\n control plane to make calls to Amazon Web Services API operations on your behalf. For\n more information, see Amazon EKS Service IAM Role in the \n Amazon EKS User Guide\n .
", + "smithy.api#required": {} + } + }, + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigRequest", + "traits": { + "smithy.api#documentation": "The VPC configuration that's used by the cluster control plane. Amazon EKS VPC\n resources have specific requirements to work properly with Kubernetes. For more information,\n see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five\n security groups. However, we recommend that you use a dedicated security group for your\n cluster control plane.
", + "smithy.api#required": {} + } + }, + "kubernetesNetworkConfig": { + "target": "com.amazonaws.eks#KubernetesNetworkConfigRequest", + "traits": { + "smithy.api#documentation": "The Kubernetes network configuration for the cluster.
" + } + }, + "logging": { + "target": "com.amazonaws.eks#Logging", + "traits": { + "smithy.api#documentation": "Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see 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.
\nA unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "encryptionConfig": { + "target": "com.amazonaws.eks#EncryptionConfigList", + "traits": { + "smithy.api#documentation": "The encryption configuration for the cluster.
" + } + }, + "outpostConfig": { + "target": "com.amazonaws.eks#OutpostConfigRequest", + "traits": { + "smithy.api#documentation": "An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review\n Local clusters\n for Amazon EKS on Amazon Web Services Outposts in the\n Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters\n on the Amazon Web Services cloud.
" + } + }, + "accessConfig": { + "target": "com.amazonaws.eks#CreateAccessConfigRequest", + "traits": { + "smithy.api#documentation": "The access configuration for the cluster.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster", + "traits": { + "smithy.api#documentation": "The full description of your new cluster.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateEksAnywhereSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateEksAnywhereSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an EKS Anywhere subscription. When a subscription is created, it is a contract\n agreement for the length of the term specified in the request. Licenses that are used to\n validate support are provisioned in Amazon Web Services License Manager and the caller account is\n granted access to EKS Anywhere Curated Packages.
", + "smithy.api#http": { + "method": "POST", + "uri": "/eks-anywhere-subscriptions", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionName", + "traits": { + "smithy.api#documentation": "The unique name for your subscription. It must be unique in your Amazon Web Services account in the\n Amazon Web Services Region you're creating the subscription in. The name can contain only alphanumeric\n characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic\n character and can't be longer than 100 characters.
", + "smithy.api#required": {} + } + }, + "term": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionTerm", + "traits": { + "smithy.api#documentation": "An object representing the term duration and term unit type of your subscription. This\n determines the term length of your subscription. Valid values are MONTHS for term unit\n and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This\n value cannot be changed after creating the subscription.
", + "smithy.api#required": {} + } + }, + "licenseQuantity": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of licenses to purchase with the subscription. Valid values are between 1\n and 100. This value can't be changed after creating the subscription.
" + } + }, + "licenseType": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType", + "traits": { + "smithy.api#documentation": "The license type for all licenses in the subscription. Valid value is CLUSTER. With\n the CLUSTER license type, each license covers support for a single EKS Anywhere\n cluster.
" + } + }, + "autoRenew": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean indicating whether the subscription auto renews at the end of the\n term.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "The metadata for a subscription to assist with categorization and organization. Each\n tag consists of a key and an optional value. Subscription tags don't propagate to any\n other resources associated with the subscription.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "The full description of the subscription.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateFargateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateFargateProfileRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateFargateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#UnsupportedAvailabilityZoneException" + } + ], + "traits": { + "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\n Access Control (RBAC) for authorization so that the kubelet\n that is running on the Fargate infrastructure can register with your\n Amazon EKS cluster so that it can appear in your cluster as a node. The pod\n execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For\n more information, see Pod 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", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreateFargateProfileRequest": { + "type": "structure", + "members": { + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Fargate profile.
", + "smithy.api#required": {} + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "podExecutionRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod\n that matches the selectors in the Fargate profile. The Pod\n execution role allows Fargate infrastructure to register with your\n cluster as a node, and it provides read access to Amazon ECR image repositories.\n For more information, see \n Pod execution\n role in the Amazon EKS User Guide.
The IDs of subnets to launch a Pod into. A Pod running on\n Fargate isn't assigned a public IP address, so only private subnets\n (with no direct route to an Internet Gateway) are accepted for this parameter.
The selectors to match for a Pod to use this Fargate\n profile. Each selector must have an associated Kubernetes namespace. Optionally,\n you can also specify labels for a namespace. You may specify\n up to five selectors in a Fargate profile.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#CreateFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "target": "com.amazonaws.eks#FargateProfile", + "traits": { + "smithy.api#documentation": "The full description of your new Fargate profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreateNodegroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreateNodegroupRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreateNodegroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a managed node group for an Amazon EKS cluster.
\nYou can only create a node group for your cluster that is equal to the current Kubernetes\n version for the cluster. All node groups are created with the latest AMI release version\n for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI\n using 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. For more information, see\n Managed node groups in the Amazon EKS User Guide.
\nWindows AMI types are only supported for commercial Amazon Web Services Regions\n that support Windows on Amazon EKS.
\nThe name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The unique name to give your node group.
", + "smithy.api#required": {} + } + }, + "scalingConfig": { + "target": "com.amazonaws.eks#NodegroupScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration details for the Auto Scaling group that is created for your\n node group.
" + } + }, + "diskSize": { + "target": "com.amazonaws.eks#BoxedInteger", + "traits": { + "smithy.api#documentation": "The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.\n If you specify launchTemplate, then don't specify diskSize, 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 subnets to use for the Auto Scaling group that is created for your node group.\n If you specify launchTemplate, then don't specify \n SubnetId\n in your launch template, 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.
Specify the instance types for a node group. If you specify a GPU instance type, make\n sure to also specify an applicable GPU AMI type with the amiType parameter.\n If you specify launchTemplate, then you can specify zero or one instance\n type in your launch template or you can specify 0-20 instance types\n for instanceTypes. If however, you specify an instance type in your launch\n template and specify any instanceTypes, the node group\n deployment will fail. If you don't specify an instance type in a launch template or for\n instanceTypes, then t3.medium is used, by default. If you\n specify Spot for capacityType, then we recommend specifying\n multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in\n the Amazon EKS User Guide.
The AMI type for your node group. 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. If your launch template uses a Windows custom AMI, then add\n eks:kube-proxy-windows to your Windows nodes rolearn in\n the aws-auth\n ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The remote access configuration to use with your node group. For Linux, the protocol\n is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify \n remoteAccess, or the node group deployment will fail.\n 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, 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 Kubernetes labels to apply to the nodes in the node group when they are\n created.
The Kubernetes taints to be applied to the nodes in the node group. For more information,\n see Node taints on\n managed node groups.
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "An object representing a node group's launch template specification. If specified,\n then do not specify instanceTypes, diskSize, or\n remoteAccess and make sure that the launch template meets the\n requirements in launchTemplateSpecification.
The node group update configuration.
" + } + }, + "capacityType": { + "target": "com.amazonaws.eks#CapacityTypes", + "traits": { + "smithy.api#documentation": "The capacity type for your node group.
" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the\n cluster is used, and this is the only accepted specified value. If you specify launchTemplate,\n and your launch template uses a custom AMI, then don't specify version, 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 version\n is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.
\nIf you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The full description of your new node group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#CreatePodIdentityAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#CreatePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#CreatePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role\n with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to\n pods and the credentials are rotated automatically.
\nAmazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
\nIf a pod uses a service account that has an association, Amazon EKS sets environment variables\n in the containers of the pod. The environment variables configure the Amazon Web Services SDKs,\n including the Command Line Interface, to use the EKS Pod Identity credentials.
\nPod Identity is a simpler method than IAM roles for service\n accounts, as this method doesn't use OIDC identity providers.\n Additionally, you can configure a role for Pod Identity once, and reuse it across\n clusters.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/pod-identity-associations", + "code": 200 + } + } + }, + "com.amazonaws.eks#CreatePodIdentityAssociationRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the cluster to create the association in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.
", + "smithy.api#required": {} + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\n agent manages credentials to assume this role for applications in the containers in the\n pods that use this service account.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
\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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The full description of your new association.
\nThe description includes an ID for the association. Use the ID of the association in further\n actions to manage the association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteAccessEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteAccessEntryRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteAccessEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an access entry.
\nDeleting an access entry of a type other than Standard can cause your\n cluster to function improperly. If you delete an access entry in error, you can recreate\n it.
The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
Deletes an Amazon EKS add-on.
\nWhen you remove an add-on, it's deleted from the cluster. You can always manually\n start an add-on on the cluster using the Kubernetes API.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/addons/{addonName}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n .
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 isn't removed.
", + "smithy.api#httpQuery": "preserve" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteAddonResponse": { + "type": "structure", + "members": { + "addon": { + "target": "com.amazonaws.eks#Addon" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an 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\n DeleteNodgroup and DeleteFargateProfile.
The name of the cluster to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster", + "traits": { + "smithy.api#documentation": "The full description of the cluster to delete.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteEksAnywhereSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteEksAnywhereSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an expired or inactive subscription. Deleting inactive subscriptions removes\n them from the Amazon Web Services Management Console view and from list/describe API responses.\n Subscriptions can only be cancelled within 7 days of creation and are cancelled by\n creating a ticket in the Amazon Web Services Support Center.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/eks-anywhere-subscriptions/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "The full description of the subscription to be deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteFargateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteFargateProfileRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteFargateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Fargate profile.
\nWhen you delete a Fargate profile, any Pod running on\n Fargate that was created with the profile is deleted. If the\n Pod matches another Fargate profile, then it is\n scheduled on Fargate with that profile. If it no longer matches any\n Fargate profiles, then it's not scheduled on Fargate\n and may remain in a pending state.
Only 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 your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Fargate profile to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "target": "com.amazonaws.eks#FargateProfile", + "traits": { + "smithy.api#documentation": "The deleted Fargate profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeleteNodegroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeleteNodegroupRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeleteNodegroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a managed node group.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeleteNodegroupRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the node group to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeleteNodegroupResponse": { + "type": "structure", + "members": { + "nodegroup": { + "target": "com.amazonaws.eks#Nodegroup", + "traits": { + "smithy.api#documentation": "The full description of your deleted node group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeletePodIdentityAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DeletePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#DeletePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a EKS Pod Identity association.
\nThe temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/pod-identity-associations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeletePodIdentityAssociationRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The cluster name that
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the association to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeletePodIdentityAssociationResponse": { + "type": "structure", + "members": { + "association": { + "target": "com.amazonaws.eks#PodIdentityAssociation", + "traits": { + "smithy.api#documentation": "The full description of the EKS Pod Identity association that was deleted.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DeprecationDetail": { + "type": "structure", + "members": { + "usage": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The deprecated version of the resource.
" + } + }, + "replacedWith": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The newer version of the resource to migrate to if applicable.
" + } + }, + "stopServingVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The version of the software where the deprecated resource version will stop being served.
" + } + }, + "startServingReplacementVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The version of the software where the newer resource version became available to migrate to if applicable.
" + } + }, + "clientStats": { + "target": "com.amazonaws.eks#ClientStats", + "traits": { + "smithy.api#documentation": "Details about Kubernetes clients using the deprecated resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary information about deprecated resource usage for an insight check in the\n UPGRADE_READINESS category.
Deregisters a connected cluster to remove it from the Amazon EKS control\n plane.
\nA connected cluster is a Kubernetes cluster that you've connected to your control plane\n using the Amazon EKS Connector.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/cluster-registrations/{name}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DeregisterClusterRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the connected cluster to deregister.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DeregisterClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeAccessEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAccessEntryRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAccessEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an access entry.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeAccessEntryRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
Information about the access entry.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeAddon": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAddonRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAddonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an Amazon EKS add-on.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/addons/{addonName}", + "code": 200 + }, + "smithy.waiters#waitable": { + "AddonActive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "addon.status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "addon.status", + "expected": "DEGRADED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "addon.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 10 + }, + "AddonDeleted": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "addon.status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 10 + } + } + } + }, + "com.amazonaws.eks#DescribeAddonConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeAddonConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeAddonConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Returns configuration options.
", + "smithy.api#http": { + "method": "GET", + "uri": "/addons/configuration-schemas", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeAddonConfigurationRequest": { + "type": "structure", + "members": { + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by\n DescribeAddonVersions.
The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
The name of the add-on.
" + } + }, + "addonVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
A JSON schema that's used to validate the configuration values you provide when an\n add-on is created or updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n .
Describes the versions for an add-on.
\nInformation such as the Kubernetes versions that you can use the add-on with, the\n owner, publisher, and the type of the add-on\n are returned.
The Kubernetes versions that you can use the add-on with.
", + "smithy.api#httpQuery": "kubernetesVersion" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#DescribeAddonVersionsRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe name of the add-on. The name must match one of the names returned by \n ListAddons\n .
The type of the add-on. For valid types, don't specify a value for this\n property.
The publisher of the add-on. For valid publishers, don't specify a value\n for this property.
The owner of the add-on. For valid owners, don't specify a value for this\n property.
The list of available versions with Kubernetes version compatibility and other\n properties.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future\n DescribeAddonVersions request. When the results of a\n DescribeAddonVersions request exceed maxResults, you can\n use this value to retrieve the next page of results. This value is null\n when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nDescribes an Amazon EKS cluster.
\nThe API server endpoint and certificate authority data returned by this operation are\n required for kubelet and kubectl to communicate with your\n Kubernetes API server. For more information, see Creating or\n updating a kubeconfig file for an Amazon EKS\n cluster.
The API server endpoint and certificate authority data aren't available until the\n cluster reaches the ACTIVE state.
The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster", + "traits": { + "smithy.api#documentation": "The full description of your specified cluster.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeEksAnywhereSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeEksAnywhereSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns descriptive information about a subscription.
", + "smithy.api#http": { + "method": "GET", + "uri": "/eks-anywhere-subscriptions/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "The full description of the subscription.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeFargateProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeFargateProfileRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeFargateProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an Fargate profile.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/fargate-profiles/{fargateProfileName}", + "code": 200 + }, + "smithy.waiters#waitable": { + "FargateProfileActive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "fargateProfile.status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "fargateProfile.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 10 + }, + "FargateProfileDeleted": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "fargateProfile.status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.eks#DescribeFargateProfileRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Fargate profile to describe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "target": "com.amazonaws.eks#FargateProfile", + "traits": { + "smithy.api#documentation": "The full description of your Fargate profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeIdentityProviderConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeIdentityProviderConfigRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeIdentityProviderConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an identity provider configuration.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/identity-provider-configs/describe", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeIdentityProviderConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identityProviderConfig": { + "target": "com.amazonaws.eks#IdentityProviderConfig", + "traits": { + "smithy.api#documentation": "An object representing an identity provider configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeIdentityProviderConfigResponse": { + "type": "structure", + "members": { + "identityProviderConfig": { + "target": "com.amazonaws.eks#IdentityProviderConfigResponse", + "traits": { + "smithy.api#documentation": "The object that represents an OpenID Connect (OIDC) identity provider\n configuration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeInsight": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeInsightRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeInsightResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Returns details about an insight that you specify using its ID.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/insights/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DescribeInsightRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the cluster to describe the insight for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The identity of the insight to describe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeInsightResponse": { + "type": "structure", + "members": { + "insight": { + "target": "com.amazonaws.eks#Insight", + "traits": { + "smithy.api#documentation": "The full description of the insight.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeNodegroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeNodegroupRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeNodegroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a managed node group.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}", + "code": 200 + }, + "smithy.waiters#waitable": { + "NodegroupActive": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "nodegroup.status", + "expected": "CREATE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "output": { + "path": "nodegroup.status", + "expected": "ACTIVE", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + }, + "NodegroupDeleted": { + "acceptors": [ + { + "state": "failure", + "matcher": { + "output": { + "path": "nodegroup.status", + "expected": "DELETE_FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "success", + "matcher": { + "errorType": "ResourceNotFoundException" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.eks#DescribeNodegroupRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the node group to describe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeNodegroupResponse": { + "type": "structure", + "members": { + "nodegroup": { + "target": "com.amazonaws.eks#Nodegroup", + "traits": { + "smithy.api#documentation": "The full description of your node group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribePodIdentityAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Returns descriptive information about an EKS Pod Identity association.
\nThis action requires the ID of the association. You can get the ID from the response to\n the CreatePodIdentityAssocation for newly created associations. Or, you can\n list the IDs for associations with ListPodIdentityAssociations and filter the\n list by namespace or service account.
The name of the cluster that the association is in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the association that you want the description of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribePodIdentityAssociationResponse": { + "type": "structure", + "members": { + "association": { + "target": "com.amazonaws.eks#PodIdentityAssociation", + "traits": { + "smithy.api#documentation": "The full description of the EKS Pod Identity association.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DescribeUpdate": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DescribeUpdateRequest" + }, + "output": { + "target": "com.amazonaws.eks#DescribeUpdateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an update to an Amazon EKS resource.
\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.
The name of the Amazon EKS cluster associated with the update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "updateId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the update to describe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon EKS node group associated with the update. This\n parameter is required if the update is a node group update.
", + "smithy.api#httpQuery": "nodegroupName" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n . This parameter is required if the update is an add-on update.
Describes an update request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DescribeUpdateResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update", + "traits": { + "smithy.api#documentation": "The full description of the specified update.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#DisassociateAccessPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#DisassociateAccessPolicyRequest" + }, + "output": { + "target": "com.amazonaws.eks#DisassociateAccessPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates an access policy from an access entry.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies/{policyArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#DisassociateAccessPolicyRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The ARN of the policy to disassociate from the access entry. For a list of\n associated policies ARNs, use ListAssociatedAccessPolicies.
Disassociates an identity provider configuration from a cluster.
\nIf you disassociate an identity provider from your cluster, users included in the\n provider can no longer access the cluster. However, you can still access the cluster\n with IAM principals.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/identity-provider-configs/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.eks#DisassociateIdentityProviderConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identityProviderConfig": { + "target": "com.amazonaws.eks#IdentityProviderConfig", + "traits": { + "smithy.api#documentation": "An object representing an identity provider configuration.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#DisassociateIdentityProviderConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#EksAnywhereSubscription": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "UUID identifying a subscription.
" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the subscription.
" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp in seconds for when the subscription was created.
" + } + }, + "effectiveDate": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp in seconds for when the subscription is effective.
" + } + }, + "expirationDate": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp in seconds for when the subscription will expire or auto renew,\n depending on the auto renew configuration of the subscription object.
" + } + }, + "licenseQuantity": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of licenses included in a subscription. Valid values are between 1 and\n 100.
" + } + }, + "licenseType": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType", + "traits": { + "smithy.api#documentation": "The type of licenses included in the subscription. Valid value is CLUSTER. With the\n CLUSTER license type, each license covers support for a single EKS Anywhere\n cluster.
" + } + }, + "term": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionTerm", + "traits": { + "smithy.api#documentation": "An EksAnywhereSubscriptionTerm object.
" + } + }, + "status": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The status of a subscription.
" + } + }, + "autoRenew": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean indicating whether or not a subscription will auto renew when it\n expires.
" + } + }, + "licenseArns": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "Amazon Web Services License Manager ARN associated with the subscription.
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "The metadata for a subscription to assist with categorization and organization. Each\n tag consists of a key and an optional value. Subscription tags do not propagate to any\n other resources associated with the subscription.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An EKS Anywhere subscription authorizing the customer to support for licensed clusters\n and access to EKS Anywhere Curated Packages.
" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType": { + "type": "enum", + "members": { + "Cluster": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cluster" + } + } + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#EksAnywhereSubscription" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "EXPIRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRING" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionStatusValues": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionStatus" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionTerm": { + "type": "structure", + "members": { + "duration": { + "target": "com.amazonaws.eks#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription.
" + } + }, + "unit": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionTermUnit", + "traits": { + "smithy.api#documentation": "The term unit of the subscription. Valid value is MONTHS.
An object representing the term duration and term unit type of your subscription. This\n determines the term length of your subscription. Valid values are MONTHS for term unit\n and 12 or 36 for term duration, indicating a 12 month or 36 month subscription.
" + } + }, + "com.amazonaws.eks#EksAnywhereSubscriptionTermUnit": { + "type": "enum", + "members": { + "MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHS" + } + } + } + }, + "com.amazonaws.eks#EncryptionConfig": { + "type": "structure", + "members": { + "resources": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "Specifies the resources to be encrypted. The only supported value is\n secrets.
Key Management Service (KMS) key. Either the ARN or the alias can be\n used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The encryption configuration for the cluster.
" + } + }, + "com.amazonaws.eks#EncryptionConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#EncryptionConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.eks#ErrorCode": { + "type": "enum", + "members": { + "SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SubnetNotFound" + } + }, + "SECURITY_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityGroupNotFound" + } + }, + "ENI_LIMIT_REACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EniLimitReached" + } + }, + "IP_NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IpNotAvailable" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "OPERATION_NOT_PERMITTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OperationNotPermitted" + } + }, + "VPC_ID_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcIdNotFound" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "NODE_CREATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeCreationFailure" + } + }, + "POD_EVICTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodEvictionFailure" + } + }, + "INSUFFICIENT_FREE_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientFreeAddresses" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "INSUFFICIENT_NUMBER_OF_REPLICAS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientNumberOfReplicas" + } + }, + "CONFIGURATION_CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationConflict" + } + }, + "ADMISSION_REQUEST_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AdmissionRequestDenied" + } + }, + "UNSUPPORTED_ADDON_MODIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedAddonModification" + } + }, + "K8S_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "K8sResourceNotFound" + } + } + } + }, + "com.amazonaws.eks#ErrorDetail": { + "type": "structure", + "members": { + "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 available 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 more complete description of the error.
" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "An optional field that contains the resource IDs associated with the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an error when an asynchronous operation fails.
" + } + }, + "com.amazonaws.eks#ErrorDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#ErrorDetail" + } + }, + "com.amazonaws.eks#FargateProfile": { + "type": "structure", + "members": { + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Fargate profile.
" + } + }, + "fargateProfileArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the Fargate profile.
" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" + } + }, + "podExecutionRoleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Pod execution role to use for any Pod\n that matches the selectors in the Fargate profile. For more information,\n see \n Pod execution role in the Amazon EKS User Guide.
The IDs of subnets to launch a Pod into.
The selectors to match for a Pod to use this Fargate\n profile.
The current status of the Fargate profile.
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an Fargate profile.
" + } + }, + "com.amazonaws.eks#FargateProfileLabel": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#String" + }, + "value": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#FargateProfileSelector": { + "type": "structure", + "members": { + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes namespace that the selector should match.
The Kubernetes labels that the selector should match. A pod must contain all of the labels\n that are specified in the selector for it to be considered a match.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an Fargate profile selector.
" + } + }, + "com.amazonaws.eks#FargateProfileSelectors": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#FargateProfileSelector" + } + }, + "com.amazonaws.eks#FargateProfileStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + } + } + }, + "com.amazonaws.eks#FargateProfilesRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#Identity": { + "type": "structure", + "members": { + "oidc": { + "target": "com.amazonaws.eks#OIDC", + "traits": { + "smithy.api#documentation": "An object representing the OpenID Connect\n identity provider information.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an identity provider.
" + } + }, + "com.amazonaws.eks#IdentityProviderConfig": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The type of the identity provider configuration. The only type available is\n oidc.
The name of the identity provider configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an identity provider configuration.
" + } + }, + "com.amazonaws.eks#IdentityProviderConfigResponse": { + "type": "structure", + "members": { + "oidc": { + "target": "com.amazonaws.eks#OidcIdentityProviderConfig", + "traits": { + "smithy.api#documentation": "An object representing an OpenID Connect (OIDC) identity provider configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The full description of your identity configuration.
" + } + }, + "com.amazonaws.eks#IdentityProviderConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#IdentityProviderConfig" + } + }, + "com.amazonaws.eks#IncludeClustersList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#Insight": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the insight.
" + } + }, + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the insight.
" + } + }, + "category": { + "target": "com.amazonaws.eks#Category", + "traits": { + "smithy.api#documentation": "The category of the insight.
" + } + }, + "kubernetesVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes minor version associated with an insight if applicable.
" + } + }, + "lastRefreshTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.
" + } + }, + "lastTransitionTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The time the status of the insight last changed.
" + } + }, + "description": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).
" + } + }, + "insightStatus": { + "target": "com.amazonaws.eks#InsightStatus", + "traits": { + "smithy.api#documentation": "An object containing more detail on the status of the insight resource.
" + } + }, + "recommendation": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A summary of how to remediate the finding of this insight if applicable.
" + } + }, + "additionalInfo": { + "target": "com.amazonaws.eks#AdditionalInfoMap", + "traits": { + "smithy.api#documentation": "Links to sources that provide additional context on the insight.
" + } + }, + "resources": { + "target": "com.amazonaws.eks#InsightResourceDetails", + "traits": { + "smithy.api#documentation": "The details about each resource listed in the insight check result.
" + } + }, + "categorySpecificSummary": { + "target": "com.amazonaws.eks#InsightCategorySpecificSummary", + "traits": { + "smithy.api#documentation": "Summary information that relates to the category of the insight. Currently only\n returned with certain insights having category UPGRADE_READINESS.
A check that provides recommendations to remedy potential upgrade-impacting issues.
" + } + }, + "com.amazonaws.eks#InsightCategorySpecificSummary": { + "type": "structure", + "members": { + "deprecationDetails": { + "target": "com.amazonaws.eks#DeprecationDetails", + "traits": { + "smithy.api#documentation": "The summary information about deprecated resource usage for an insight check in the\n UPGRADE_READINESS category.
Summary information that relates to the category of the insight. Currently only\n returned with certain insights having category UPGRADE_READINESS.
An object containing more detail on the status of the insight resource.
" + } + }, + "kubernetesResourceUri": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes resource URI if applicable.
" + } + }, + "arn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) if applicable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns information about the resource being evaluated.
" + } + }, + "com.amazonaws.eks#InsightResourceDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#InsightResourceDetail" + } + }, + "com.amazonaws.eks#InsightStatus": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.eks#InsightStatusValue", + "traits": { + "smithy.api#documentation": "The status of the resource.
" + } + }, + "reason": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "Explanation on the reasoning for the status of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of the insight.
" + } + }, + "com.amazonaws.eks#InsightStatusValue": { + "type": "enum", + "members": { + "PASSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSING" + } + }, + "WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARNING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.eks#InsightStatusValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#InsightStatusValue" + } + }, + "com.amazonaws.eks#InsightSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#InsightSummary" + } + }, + "com.amazonaws.eks#InsightSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the insight.
" + } + }, + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the insight.
" + } + }, + "category": { + "target": "com.amazonaws.eks#Category", + "traits": { + "smithy.api#documentation": "The category of the insight.
" + } + }, + "kubernetesVersion": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes minor version associated with an insight if applicable.
" + } + }, + "lastRefreshTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.
" + } + }, + "lastTransitionTime": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The time the status of the insight last changed.
" + } + }, + "description": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).
" + } + }, + "insightStatus": { + "target": "com.amazonaws.eks#InsightStatus", + "traits": { + "smithy.api#documentation": "An object containing more detail on the status of the insight.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summarized description of the insight.
" + } + }, + "com.amazonaws.eks#InsightsFilter": { + "type": "structure", + "members": { + "categories": { + "target": "com.amazonaws.eks#CategoryList", + "traits": { + "smithy.api#documentation": "The categories to use to filter insights.
" + } + }, + "kubernetesVersions": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The Kubernetes versions to use to filter the insights.
" + } + }, + "statuses": { + "target": "com.amazonaws.eks#InsightStatusValueList", + "traits": { + "smithy.api#documentation": "The statuses to use to filter the insights.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The criteria to use for the insights.
" + } + }, + "com.amazonaws.eks#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.eks#InvalidParameterException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Fargate profile associated with the exception.
" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The specified parameter for the add-on name is invalid. Review the available\n parameters for the API request
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#InvalidRequestException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The request is invalid given the state of the add-on name. Check the state of the\n cluster and the associated operations.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request is invalid given the state of the cluster. Check the state of the cluster\n and the associated operations.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#IpFamily": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ipv4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "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\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\n the Amazon 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\n this failure are insufficient node IAM\n role permissions or lack of outbound internet access for the nodes.\n
\nThe error message associated with the issue.
" + } + }, + "resourceIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The Amazon Web Services resources that are afflicted by this issue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an issue with an Amazon EKS resource.
" + } + }, + "com.amazonaws.eks#IssueList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Issue" + } + }, + "com.amazonaws.eks#KubernetesNetworkConfigRequest": { + "type": "structure", + "members": { + "serviceIpv4Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from. If\n you don't specify a block, Kubernetes assigns addresses from either the\n 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend\n that you specify a block that does not overlap with resources in other networks that are\n peered or connected to your VPC. The block must meet the following requirements:
Within one of the following private IP address blocks:\n 10.0.0.0/8, 172.16.0.0/12, or\n 192.168.0.0/16.
Doesn't overlap with any CIDR block assigned to the VPC that you selected for\n VPC.
\nBetween /24 and /12.
You can only specify a custom CIDR block when you create a cluster. You can't\n change this value after the cluster is created.
\nSpecify which IP family is used to assign Kubernetes pod and service IP addresses. If you\n don't specify a value, ipv4 is used by default. You can only specify an IP\n 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\n assigned to them. You can't specify ipv6 for clusters in China\n Regions.
You can only specify ipv6 for 1.21 and later clusters that\n use version 1.10.1 or later of the Amazon VPC CNI add-on. If you specify\n ipv6, then ensure that your VPC meets the requirements listed in the\n considerations listed in Assigning IPv6 addresses to pods and\n services in the Amazon EKS User Guide. Kubernetes assigns services\n IPv6 addresses from the unique local address range\n (fc00::/7). You can't specify a custom IPv6 CIDR block.\n Pod addresses are assigned from the subnet's IPv6 CIDR.
The Kubernetes network configuration for the cluster.
" + } + }, + "com.amazonaws.eks#KubernetesNetworkConfigResponse": { + "type": "structure", + "members": { + "serviceIpv4Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The CIDR block that Kubernetes Pod and Service object IP\n addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR\n block assigned to a subnet that the node is in. If you didn't specify a CIDR block when\n you created the cluster, then Kubernetes assigns addresses from either the\n 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was\n specified, then it was specified when the cluster was created and it can't be\n changed.
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.1 or later of the Amazon VPC CNI add-on and\n specified ipv6 for ipFamily when you\n created the cluster. Kubernetes assigns service addresses from the unique local address range\n (fc00::/7) because you can't specify a custom IPv6 CIDR block when you\n create the cluster.
The IP family used to assign Kubernetes Pod and Service objects\n IP addresses. The IP family is always ipv4, unless you have a\n 1.21 or later cluster running version 1.10.1 or later of\n the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.\n
The Kubernetes network configuration for the cluster. The response contains a value for\n serviceIpv6Cidr or serviceIpv4Cidr, but not both.
" + } + }, + "com.amazonaws.eks#LaunchTemplateSpecification": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template name or the launch template ID in the\n request, but not both.
" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The version number of the launch template to use. If no version is specified, then the\n template's default version is used.
" + } + }, + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the launch template name in the\n request, but not both.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing a node group launch template specification. The launch template\n can't 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.
You must specify either the launch template ID or the launch template name in the\n request, but not both.
" + } + }, + "com.amazonaws.eks#ListAccessEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListAccessEntriesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListAccessEntriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the access entries for your cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/access-entries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "accessEntries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAccessEntriesRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associatedPolicyArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of an AccessPolicy. When you specify an access policy ARN,\n only the access entries associated to that access policy are returned. For a list of\n available policy ARNs, use ListAccessPolicies.
The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of access entries that exist for the cluster.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the available access policies.
", + "smithy.api#http": { + "method": "GET", + "uri": "/access-policies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "accessPolicies", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAccessPoliciesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.eks#ListAccessPoliciesRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of available access policies. You can't view the contents of an access policy\n using the API. To view the contents, see Access\n policy permissions in the Amazon EKS User Guide.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the installed add-ons.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/addons", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "addons", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAddonsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListAddonsRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of installed add-ons.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future ListAddons\n request. When the results of a ListAddons request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the access policies associated with an access entry.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "associatedAccessPolicies", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListAssociatedAccessPoliciesRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe name of your cluster.
" + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of access policies associated with the access entry.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListClustersRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Amazon EKS clusters in your Amazon Web Services account in the\n specified Amazon Web Services Region.
", + "smithy.api#examples": [ + { + "title": "To list your available clusters", + "documentation": "This example command lists all of your available clusters in your default region.", + "output": { + "clusters": [ + "devel", + "prod" + ] + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/clusters", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "clusters", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListClustersRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.eks#ListClustersRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nIndicates whether external clusters are included in the returned list. Use\n 'all' to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to\n return only Amazon EKS clusters. 'all' must be in lowercase\n otherwise an error occurs.
A list of all of the clusters for your account in the specified Amazon Web Services Region.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nDisplays the full description of the subscription.
", + "smithy.api#http": { + "method": "GET", + "uri": "/eks-anywhere-subscriptions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "subscriptions", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of cluster results returned by ListEksAnywhereSubscriptions in\n paginated output. When you use this parameter, ListEksAnywhereSubscriptions returns only\n maxResults results in a single page along with a nextToken response element. You can see\n the remaining results of the initial request by sending another\n ListEksAnywhereSubscriptions request with the returned nextToken value. This value can\n be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions\n returns up to 10 results and a nextToken value if applicable.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated\n ListEksAnywhereSubscriptions request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.
An array of subscription statuses to filter on.
", + "smithy.api#httpQuery": "includeStatus" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequestMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListEksAnywhereSubscriptionsResponse": { + "type": "structure", + "members": { + "subscriptions": { + "target": "com.amazonaws.eks#EksAnywhereSubscriptionList", + "traits": { + "smithy.api#documentation": "A list of all subscription objects in the region, filtered by includeStatus and\n paginated by nextToken and maxResults.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future ListEksAnywhereSubscriptions request. When\n the results of a ListEksAnywhereSubscriptions request exceed maxResults, you can use\n this value to retrieve the next page of results. This value is null when there are no\n more results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListFargateProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListFargateProfilesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListFargateProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Fargate profiles associated with the specified cluster in\n your Amazon Web Services account in the specified Amazon Web Services Region.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/fargate-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "fargateProfileNames", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListFargateProfilesRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#FargateProfilesRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of all of the Fargate profiles associated with the specified\n cluster.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the identity provider configurations for your cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/identity-provider-configs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "identityProviderConfigs", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListIdentityProviderConfigsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListIdentityProviderConfigsRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe identity provider configurations for the cluster.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future\n ListIdentityProviderConfigsResponse request. When the results of a\n ListIdentityProviderConfigsResponse request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nReturns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/insights", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "insights", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListInsightsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListInsightsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon EKS cluster associated with the insights.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "filter": { + "target": "com.amazonaws.eks#InsightsFilter", + "traits": { + "smithy.api#documentation": "The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListInsightsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of identity provider configurations returned by\n ListInsights in paginated output. When you use this parameter,\n ListInsights returns only maxResults results in a single\n page along with a nextToken response element. You can see the remaining\n results of the initial request by sending another ListInsights request with\n the returned nextToken value. This value can be between 1\n and 100. If you don't use this parameter, ListInsights\n returns up to 100 results and a nextToken value, if\n applicable.
The nextToken value returned from a previous paginated ListInsights\n request. When the results of a ListInsights request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.
The returned list of insights.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value to include in a future ListInsights\n request. When the results of a ListInsights request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.
Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node\n groups aren't listed.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/node-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "nodegroups", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListNodegroupsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListNodegroupsRequestMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of all of the node groups associated with the specified cluster.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nList the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the\n association is in or the service account that the association uses.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{clusterName}/pod-identity-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "associations", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListPodIdentityAssociationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#ListPodIdentityAssociationsRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the cluster that the associations are in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster that the associations are in.
", + "smithy.api#httpQuery": "namespace" + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes service account that the associations use.
", + "smithy.api#httpQuery": "serviceAccount" + } + }, + "maxResults": { + "target": "com.amazonaws.eks#ListPodIdentityAssociationsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of EKS Pod Identity association results returned by\n ListPodIdentityAssociations in paginated output. When you use this\n parameter, ListPodIdentityAssociations returns only maxResults\n results in a single page along with a nextToken response element. You can\n see the remaining results of the initial request by sending another\n ListPodIdentityAssociations request with the returned\n nextToken value. This value can be between 1 and\n 100. If you don't use this parameter,\n ListPodIdentityAssociations returns up to 100 results\n and a nextToken value if applicable.
The nextToken value returned from a previous paginated\n ListUpdates request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of summarized descriptions of the associations that are in the cluster and match any\n filters that you provided.
\nEach summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :
The IAM role: roleArn\n
The timestamp that the association was created at: createdAt\n
The most recent timestamp that the association was modified at:. modifiedAt\n
The tags on the association: tags\n
The nextToken value to include in a future\n ListPodIdentityAssociations request. When the results of a\n ListPodIdentityAssociations request exceed maxResults, you\n can use this value to retrieve the next page of results. This value is null\n when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nList the tags for an Amazon EKS resource.
", + "smithy.api#examples": [ + { + "title": "To list tags for a cluster", + "documentation": "This example lists all of the tags for the `beta` cluster.", + "input": { + "resourceArn": "arn:aws:eks:us-west-2:012345678910:cluster/beta" + }, + "output": { + "tags": { + "aws:tag:domain": "beta" + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list tags for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "The tags for the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#ListUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#ListUpdatesRequest" + }, + "output": { + "target": "com.amazonaws.eks#ListUpdatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
", + "smithy.api#http": { + "method": "GET", + "uri": "/clusters/{name}/updates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "updateIds", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.eks#ListUpdatesRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon EKS cluster to list updates for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon EKS managed node group to list updates for.
", + "smithy.api#httpQuery": "nodegroupName" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The names of the installed add-ons that have available updates.
", + "smithy.api#httpQuery": "addonName" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
A list of all the updates for the specified cluster and Region.
" + } + }, + "nextToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe available cluster control plane log types.
" + } + }, + "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 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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the enabled or disabled Kubernetes control plane logs for your\n cluster.
" + } + }, + "com.amazonaws.eks#LogSetups": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#LogSetup" + } + }, + "com.amazonaws.eks#LogType": { + "type": "enum", + "members": { + "API": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "api" + } + }, + "AUDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "audit" + } + }, + "AUTHENTICATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "authenticator" + } + }, + "CONTROLLER_MANAGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "controllerManager" + } + }, + "SCHEDULER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "scheduler" + } + } + } + }, + "com.amazonaws.eks#LogTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#LogType" + } + }, + "com.amazonaws.eks#Logging": { + "type": "structure", + "members": { + "clusterLogging": { + "target": "com.amazonaws.eks#LogSetups", + "traits": { + "smithy.api#documentation": "The cluster control plane logging configuration for your cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the logging configuration for resources in your cluster.
" + } + }, + "com.amazonaws.eks#MarketplaceInformation": { + "type": "structure", + "members": { + "productId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The product ID from the Amazon Web Services Marketplace.
" + } + }, + "productUrl": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The product URL from the Amazon Web Services Marketplace.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.
" + } + }, + "com.amazonaws.eks#Nodegroup": { + "type": "structure", + "members": { + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name associated with an Amazon EKS managed node group.
" + } + }, + "nodegroupArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the managed node group.
" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
" + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes version of the managed node group.
" + } + }, + "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\n optimized AMI that the node group was deployed with.
" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp for the last modification to the object.
" + } + }, + "status": { + "target": "com.amazonaws.eks#NodegroupStatus", + "traits": { + "smithy.api#documentation": "The current status of the managed node group.
" + } + }, + "capacityType": { + "target": "com.amazonaws.eks#CapacityTypes", + "traits": { + "smithy.api#documentation": "The capacity type of your managed node group.
" + } + }, + "scalingConfig": { + "target": "com.amazonaws.eks#NodegroupScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration details for the Auto Scaling group that is associated with\n your node group.
" + } + }, + "instanceTypes": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "If the node group wasn't deployed with a launch template, then this is the instance\n type that is associated with the node group. If the node group was deployed with a\n launch template, then this is null.
The subnets that were specified for the Auto Scaling group that is associated with\n your node group.
" + } + }, + "remoteAccess": { + "target": "com.amazonaws.eks#RemoteAccessConfig", + "traits": { + "smithy.api#documentation": "If the node group wasn't deployed with a launch template, then this is the remote\n access configuration that is associated with the node group. If the node group was\n deployed with a launch template, then this is null.
If the node group was deployed using a launch template with a custom AMI, then this is\n CUSTOM. For node groups that weren't deployed using a launch template,\n this is the AMI type that was specified in the node group configuration.
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.
Only labels that are applied with the Amazon EKS API are\n shown here. There may be other Kubernetes labels applied to the nodes in\n this group.
The Kubernetes taints to be applied to the nodes in the node group when they are created.\n 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. For more information, see Node taints on managed node groups.
The resources associated with the node group, such as Auto Scaling groups and security\n groups for remote access.
" + } + }, + "diskSize": { + "target": "com.amazonaws.eks#BoxedInteger", + "traits": { + "smithy.api#documentation": "If the node group wasn't deployed with a launch template, then this is the disk size\n in the node group configuration. If the node group was deployed with a launch template,\n then this is null.
The health status of the node group. If there are issues with your node group's\n health, they are listed here.
" + } + }, + "updateConfig": { + "target": "com.amazonaws.eks#NodegroupUpdateConfig", + "traits": { + "smithy.api#documentation": "The node group update configuration.
" + } + }, + "launchTemplate": { + "target": "com.amazonaws.eks#LaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "If a launch template was used to create the node group, then this is the launch\n template that was used.
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an Amazon EKS managed node group.
" + } + }, + "com.amazonaws.eks#NodegroupHealth": { + "type": "structure", + "members": { + "issues": { + "target": "com.amazonaws.eks#IssueList", + "traits": { + "smithy.api#documentation": "Any issues that are associated with the node group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the health status of the node group.
" + } + }, + "com.amazonaws.eks#NodegroupIssueCode": { + "type": "enum", + "members": { + "AUTO_SCALING_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupNotFound" + } + }, + "AUTO_SCALING_GROUP_INVALID_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupInvalidConfiguration" + } + }, + "EC2_SECURITY_GROUP_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SecurityGroupNotFound" + } + }, + "EC2_SECURITY_GROUP_DELETION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SecurityGroupDeletionFailure" + } + }, + "EC2_LAUNCH_TEMPLATE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateNotFound" + } + }, + "EC2_LAUNCH_TEMPLATE_VERSION_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateVersionMismatch" + } + }, + "EC2_SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetNotFound" + } + }, + "EC2_SUBNET_INVALID_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetInvalidConfiguration" + } + }, + "IAM_INSTANCE_PROFILE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamInstanceProfileNotFound" + } + }, + "EC2_SUBNET_MISSING_IPV6_ASSIGNMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetMissingIpv6Assignment" + } + }, + "IAM_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamLimitExceeded" + } + }, + "IAM_NODE_ROLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamNodeRoleNotFound" + } + }, + "NODE_CREATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeCreationFailure" + } + }, + "ASG_INSTANCE_LAUNCH_FAILURES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AsgInstanceLaunchFailures" + } + }, + "INSTANCE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceLimitExceeded" + } + }, + "INSUFFICIENT_FREE_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientFreeAddresses" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + }, + "CLUSTER_UNREACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterUnreachable" + } + }, + "AMI_ID_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AmiIdNotFound" + } + }, + "AUTO_SCALING_GROUP_OPT_IN_REQUIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupOptInRequired" + } + }, + "AUTO_SCALING_GROUP_RATE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupRateLimitExceeded" + } + }, + "EC2_LAUNCH_TEMPLATE_DELETION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateDeletionFailure" + } + }, + "EC2_LAUNCH_TEMPLATE_INVALID_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateInvalidConfiguration" + } + }, + "EC2_LAUNCH_TEMPLATE_MAX_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2LaunchTemplateMaxLimitExceeded" + } + }, + "EC2_SUBNET_LIST_TOO_LONG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ec2SubnetListTooLong" + } + }, + "IAM_THROTTLING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IamThrottling" + } + }, + "NODE_TERMINATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NodeTerminationFailure" + } + }, + "POD_EVICTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PodEvictionFailure" + } + }, + "SOURCE_EC2_LAUNCH_TEMPLATE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SourceEc2LaunchTemplateNotFound" + } + }, + "LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LimitExceeded" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "AUTO_SCALING_GROUP_INSTANCE_REFRESH_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AutoScalingGroupInstanceRefreshActive" + } + } + } + }, + "com.amazonaws.eks#NodegroupResources": { + "type": "structure", + "members": { + "autoScalingGroups": { + "target": "com.amazonaws.eks#AutoScalingGroupList", + "traits": { + "smithy.api#documentation": "The Auto Scaling groups associated with the node group.
" + } + }, + "remoteAccessSecurityGroup": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The remote access security group associated with the node group. This security group\n controls SSH access to the nodes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the resources associated with the node group, such as Auto\n Scaling groups and security groups for remote access.
" + } + }, + "com.amazonaws.eks#NodegroupScalingConfig": { + "type": "structure", + "members": { + "minSize": { + "target": "com.amazonaws.eks#ZeroCapacity", + "traits": { + "smithy.api#documentation": "The minimum number of nodes that the managed node group can scale in to.
" + } + }, + "maxSize": { + "target": "com.amazonaws.eks#Capacity", + "traits": { + "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 the Kubernetes Cluster\n 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.
Whenever 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\n starting with extra hosts for testing. This parameter can also be different when you\n want to start with an estimated number of needed hosts, but let the Cluster Autoscaler\n reduce the number if there are too many. When the Cluster Autoscaler is used, the\n desiredSize parameter is altered by the Cluster Autoscaler (but can be\n out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed\n node group lower than minSize or higher than maxSize.
An object representing the scaling configuration details for the Auto Scaling\n group that is associated with your node group. When creating a node group, you must\n specify all or none of the properties. When updating a node group, you can specify any\n or none of the properties.
" + } + }, + "com.amazonaws.eks#NodegroupStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "DEGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEGRADED" + } + } + } + }, + "com.amazonaws.eks#NodegroupUpdateConfig": { + "type": "structure", + "members": { + "maxUnavailable": { + "target": "com.amazonaws.eks#NonZeroInteger", + "traits": { + "smithy.api#documentation": "The maximum number of nodes unavailable at once during a version update. Nodes are\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\n of nodes are updated in parallel, up to 100 nodes at once. This value or\n maxUnavailable is required to have a value.
The node group update configuration.
" + } + }, + "com.amazonaws.eks#NonZeroInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.eks#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A service resource associated with the request could not be found. Clients should not\n retry such requests.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A service resource associated with the request could not be found. Clients should not\n retry such requests.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.eks#OIDC": { + "type": "structure", + "members": { + "issuer": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The issuer URL for the OIDC identity provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the OpenID Connect\n (OIDC) identity provider information for the cluster.
" + } + }, + "com.amazonaws.eks#OidcIdentityProviderConfig": { + "type": "structure", + "members": { + "identityProviderConfigName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the configuration.
" + } + }, + "identityProviderConfigArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the configuration.
" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
" + } + }, + "issuerUrl": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The URL of the OIDC identity provider that allows the API server to discover public\n signing keys for verifying tokens.
" + } + }, + "clientId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "This is also known as audience. The ID of the client application\n that makes authentication requests to the OIDC identity provider.
" + } + }, + "usernameClaim": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The JSON Web token (JWT) claim that is used as the username.
" + } + }, + "usernamePrefix": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The prefix that is prepended to username claims to prevent clashes with existing\n names. The prefix can't contain system:\n
The JSON web token (JWT) claim that the provider uses to return your groups.
" + } + }, + "groupsPrefix": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The prefix that is prepended to group claims to prevent clashes with existing names\n (such as system: groups). For example, the value oidc: creates\n group names like oidc:engineering and oidc:infra. The prefix\n can't contain system:\n
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.
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + }, + "status": { + "target": "com.amazonaws.eks#configStatus", + "traits": { + "smithy.api#documentation": "The status of the OIDC identity provider.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the configuration for an OpenID Connect (OIDC) identity provider.\n
" + } + }, + "com.amazonaws.eks#OidcIdentityProviderConfigRequest": { + "type": "structure", + "members": { + "identityProviderConfigName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the OIDC provider configuration.
", + "smithy.api#required": {} + } + }, + "issuerUrl": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The URL of the OIDC identity provider that allows the API server to discover public\n signing keys for verifying tokens. The URL must begin with https:// and\n should correspond to the iss claim in the provider's OIDC ID tokens.\n Based on the OIDC standard, path components are allowed but query parameters are not.\n Typically the URL consists of only a hostname, like\n https://server.example.org or https://example.com. This\n URL should point to the level below .well-known/openid-configuration and\n must be publicly accessible over the internet.
This is also known as audience. The ID for the client application\n that makes authentication requests to the OIDC identity provider.
", + "smithy.api#required": {} + } + }, + "usernameClaim": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The JSON Web Token (JWT) claim to use as the username. The default is\n sub, which is expected to be a unique identifier of the end user. You can\n choose other claims, such as email or name, depending on the\n OIDC identity provider. Claims other than email are prefixed with the\n issuer URL to prevent naming clashes with other plug-ins.
The prefix that is prepended to username claims to prevent clashes with existing\n names. If you do not provide this field, and username is a value other than\n email, the prefix defaults to issuerurl#. You can use the\n value - to disable all prefixing.
The JWT claim that the provider uses to return your groups.
" + } + }, + "groupsPrefix": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The prefix that is prepended to group claims to prevent clashes with existing names\n (such as system: groups). For example, the value oidc: will\n create group names like oidc:engineering and\n oidc:infra.
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.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing an OpenID Connect (OIDC) configuration. Before associating an\n OIDC identity provider to your cluster, review the considerations in Authenticating\n users for your cluster from an OIDC identity provider in the\n Amazon EKS User Guide.
" + } + }, + "com.amazonaws.eks#OutpostConfigRequest": { + "type": "structure", + "members": { + "outpostArns": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The ARN of the Outpost that you want to use for your local Amazon EKS\n cluster on Outposts. Only a single Outpost ARN is supported.
", + "smithy.api#required": {} + } + }, + "controlPlaneInstanceType": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes\n that your cluster will have. For more information, see Capacity\n considerations in the Amazon EKS User Guide.
\nThe instance type that you specify is used for all Kubernetes control plane instances. The\n instance type can't be changed after cluster creation. The control plane is not\n automatically scaled by Amazon EKS.
\n", + "smithy.api#required": {} + } + }, + "controlPlanePlacement": { + "target": "com.amazonaws.eks#ControlPlanePlacementRequest", + "traits": { + "smithy.api#documentation": "
An object representing the placement configuration for all the control plane instances\n of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more\n information, see Capacity considerations in the Amazon EKS User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration of your local Amazon EKS cluster on an Amazon Web Services\n Outpost. Before creating a cluster on an Outpost, review Creating a local\n cluster on an Outpost in the Amazon EKS User Guide. This API isn't available for\n Amazon EKS clusters on the Amazon Web Services cloud.
" + } + }, + "com.amazonaws.eks#OutpostConfigResponse": { + "type": "structure", + "members": { + "outpostArns": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The ARN of the Outpost that you specified for use with your local Amazon EKS\n cluster on Outposts.
", + "smithy.api#required": {} + } + }, + "controlPlaneInstanceType": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EC2 instance type used for the control plane. The instance type is\n the same for all control plane instances.
", + "smithy.api#required": {} + } + }, + "controlPlanePlacement": { + "target": "com.amazonaws.eks#ControlPlanePlacementResponse", + "traits": { + "smithy.api#documentation": "An object representing the placement configuration for all the control plane instances\n of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more\n information, see Capacity\n considerations in the Amazon EKS User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. This API isn't available for Amazon EKS clusters\n on the Amazon Web Services cloud.
" + } + }, + "com.amazonaws.eks#PercentCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.eks#PodIdentityAssociation": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the cluster that the association is in.
" + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.
" + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
" + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\n agent manages credentials to assume this role for applications in the containers in the\n pods that use this service account.
" + } + }, + "associationArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the association.
" + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the association.
" + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
\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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The timestamp that the association was created at.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The most recent timestamp that the association was modified at
" + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
" + } + }, + "com.amazonaws.eks#PodIdentityAssociationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#PodIdentityAssociationSummary" + } + }, + "com.amazonaws.eks#PodIdentityAssociationSummary": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the cluster that the association is in.
" + } + }, + "namespace": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.
" + } + }, + "serviceAccount": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
" + } + }, + "associationArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the association.
" + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summarized description of the association.
\nEach summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :
The IAM role: roleArn\n
The timestamp that the association was created at: createdAt\n
The most recent timestamp that the association was modified at:. modifiedAt\n
The tags on the association: tags\n
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be\n symmetric and created in the same Amazon Web Services Region as the cluster. If the\n KMS key was created in a different account, the IAM principal must\n have access to the KMS key. For more information, see Allowing\n users in other accounts to use a KMS key in the\n Key Management Service Developer Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Identifies the Key Management Service (KMS) key used to encrypt the\n secrets.
" + } + }, + "com.amazonaws.eks#RegisterCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#RegisterClusterRequest" + }, + "output": { + "target": "com.amazonaws.eks#RegisterClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#AccessDeniedException" + }, + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.eks#ResourcePropagationDelayException" + }, + { + "target": "com.amazonaws.eks#ServerException" + }, + { + "target": "com.amazonaws.eks#ServiceUnavailableException" + } + ], + "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\n 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 native\n provider to provide visibility.
After the manifest is updated and applied, the connected cluster is visible to the\n Amazon EKS control plane. If the manifest isn't applied within three days,\n the connected cluster will no longer be visible and must be deregistered using\n DeregisterCluster.
A unique name for this cluster in your Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "connectorConfig": { + "target": "com.amazonaws.eks#ConnectorConfigRequest", + "traits": { + "smithy.api#documentation": "The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#RegisterClusterResponse": { + "type": "structure", + "members": { + "cluster": { + "target": "com.amazonaws.eks#Cluster" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#RemoteAccessConfig": { + "type": "structure", + "members": { + "ec2SshKey": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EC2 SSH key name that provides access for SSH communication with\n the 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. For\n Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more\n information, see Amazon EC2 key pairs and Windows instances in\n the Amazon Elastic Compute Cloud User Guide for Windows Instances.
" + } + }, + "sourceSecurityGroups": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The security group IDs that are allowed SSH access (port 22) to the nodes. For\n Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't\n specify a source security group when you create a managed node group, then the port on\n the nodes is opened to the internet (0.0.0.0/0). For more information, see\n Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
An object representing the remote access configuration for the managed node\n group.
" + } + }, + "com.amazonaws.eks#ResolveConflicts": { + "type": "enum", + "members": { + "OVERWRITE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERWRITE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PRESERVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESERVE" + } + } + } + }, + "com.amazonaws.eks#ResourceInUseException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The specified add-on name is in use.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS message associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource is in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.eks#ResourceLimitExceededException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS message associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You have encountered a service limit on the specified resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.eks#ResourceNotFoundException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "fargateProfileName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Fargate profile associated with the exception.
" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS message associated with the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified resource could not be found. You can view your available clusters with\n ListClusters. You can view your available managed node groups with\n ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.
Required resources (such as service-linked roles) were created and are still\n propagating. Retry later.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Required resources (such as service-linked roles) were created and are still\n propagating. Retry later.
", + "smithy.api#error": "client", + "smithy.api#httpError": 428 + } + }, + "com.amazonaws.eks#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.eks#ServerException": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" + } + }, + "subscriptionId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" + } + }, + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "These errors are usually caused by a server-side issue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "These errors are usually caused by a server-side issue.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.eks#ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The request has failed due to a temporary failure of the server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The service is unavailable. Back off and retry the operation.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.eks#String": { + "type": "string" + }, + "com.amazonaws.eks#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#TagKey": { + "type": "string", + "traits": { + "smithy.api#documentation": "One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.
The metadata that you apply to a resource to help you categorize and organize them.\n Each tag consists of a key and an optional value. You define them.
\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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Associates the specified tags to an Amazon EKS resource with the specified\n resourceArn. If existing tags on a resource are not specified in the\n request parameters, they aren't changed. When a resource is deleted, the tags associated\n with that resource are also deleted. Tags that you create for Amazon EKS\n resources don't propagate to any other resources associated with the cluster. For\n example, if you tag a cluster with this operation, that tag doesn't automatically\n propagate to the subnets and nodes associated with the cluster.
The Amazon Resource Name (ARN) of the resource to add tags to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#TagValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "The optional part of a key-value pair that make up a tag. A value acts as\n a descriptor within a tag category (key).
The key of the taint.
" + } + }, + "value": { + "target": "com.amazonaws.eks#taintValue", + "traits": { + "smithy.api#documentation": "The value of the taint.
" + } + }, + "effect": { + "target": "com.amazonaws.eks#TaintEffect", + "traits": { + "smithy.api#documentation": "The effect of the taint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A property that allows a node to repel a Pod. For more information, see\n Node taints on\n managed node groups in the Amazon EKS User Guide.
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.
" + } + }, + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" + } + }, + "validZones": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The supported Availability Zones for your account. Choose subnets in these\n Availability Zones for your cluster.
" + } + } + }, + "traits": { + "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 + } + }, + "com.amazonaws.eks#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.eks#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#BadRequestException" + }, + { + "target": "com.amazonaws.eks#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes specified tags from an Amazon EKS resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to delete tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.eks#TagKeyList", + "traits": { + "smithy.api#documentation": "The keys of the tags to remove.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#Update": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A UUID that is used to track the update.
" + } + }, + "status": { + "target": "com.amazonaws.eks#UpdateStatus", + "traits": { + "smithy.api#documentation": "The current status of the update.
" + } + }, + "type": { + "target": "com.amazonaws.eks#UpdateType", + "traits": { + "smithy.api#documentation": "The type of the update.
" + } + }, + "params": { + "target": "com.amazonaws.eks#UpdateParams", + "traits": { + "smithy.api#documentation": "A key-value map that contains the parameters associated with the update.
" + } + }, + "createdAt": { + "target": "com.amazonaws.eks#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" + } + }, + "errors": { + "target": "com.amazonaws.eks#ErrorDetails", + "traits": { + "smithy.api#documentation": "Any errors associated with a Failed update.
An object representing an asynchronous update.
" + } + }, + "com.amazonaws.eks#UpdateAccessConfigRequest": { + "type": "structure", + "members": { + "authenticationMode": { + "target": "com.amazonaws.eks#AuthenticationMode", + "traits": { + "smithy.api#documentation": "The desired authentication mode for the cluster.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The access configuration information for the cluster.
" + } + }, + "com.amazonaws.eks#UpdateAccessEntry": { + "type": "operation", "input": { - "name": "prod", - "version": "1.10", - "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", - "resourcesVpcConfig": { - "subnetIds": ["subnet-6782e71e", "subnet-e7e761ac"], - "securityGroupIds": ["sg-6979fe18"] - }, - "clientRequestToken": "1d2129a1-3d38-460a-9756-e5b91fddb951" - }, - "output": {} - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/clusters", - "code": 200 - } - } - }, - "com.amazonaws.eks#CreateClusterRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#ClusterName", - "traits": { - "smithy.api#documentation": "The unique name to give to your cluster.
", - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The desired Kubernetes version for your cluster. If you don't specify a value here, the\n default version available in Amazon EKS is used.
\nThe default version might not be the latest version available.
\nThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes\n control plane to make calls to Amazon Web Services API operations on your behalf. For\n more information, see Amazon EKS Service IAM Role in the \n Amazon EKS User Guide\n .
", - "smithy.api#required": {} - } - }, - "resourcesVpcConfig": { - "target": "com.amazonaws.eks#VpcConfigRequest", - "traits": { - "smithy.api#documentation": "The VPC configuration that's used by the cluster control plane. Amazon EKS VPC\n resources have specific requirements to work properly with Kubernetes. For more information,\n see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five\n security groups. However, we recommend that you use a dedicated security group for your\n cluster control plane.
", - "smithy.api#required": {} - } - }, - "kubernetesNetworkConfig": { - "target": "com.amazonaws.eks#KubernetesNetworkConfigRequest", - "traits": { - "smithy.api#documentation": "The Kubernetes network configuration for the cluster.
" - } - }, - "logging": { - "target": "com.amazonaws.eks#Logging", - "traits": { - "smithy.api#documentation": "Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see 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.
\nA unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "encryptionConfig": { - "target": "com.amazonaws.eks#EncryptionConfigList", - "traits": { - "smithy.api#documentation": "The encryption configuration for the cluster.
" - } - }, - "outpostConfig": { - "target": "com.amazonaws.eks#OutpostConfigRequest", - "traits": { - "smithy.api#documentation": "An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review\n Local clusters\n for Amazon EKS on Amazon Web Services Outposts in the\n Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters\n on the Amazon Web Services cloud.
" - } - }, - "accessConfig": { - "target": "com.amazonaws.eks#CreateAccessConfigRequest", - "traits": { - "smithy.api#documentation": "The access configuration for the cluster.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#CreateClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.eks#Cluster", - "traits": { - "smithy.api#documentation": "The full description of your new cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#CreateEksAnywhereSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#CreateEksAnywhereSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.eks#CreateEksAnywhereSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an EKS Anywhere subscription. When a subscription is created, it is a contract\n agreement for the length of the term specified in the request. Licenses that are used to\n validate support are provisioned in Amazon Web Services License Manager and the caller account is\n granted access to EKS Anywhere Curated Packages.
", - "smithy.api#http": { - "method": "POST", - "uri": "/eks-anywhere-subscriptions", - "code": 200 - } - } - }, - "com.amazonaws.eks#CreateEksAnywhereSubscriptionRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionName", - "traits": { - "smithy.api#documentation": "The unique name for your subscription. It must be unique in your Amazon Web Services account in the\n Amazon Web Services Region you're creating the subscription in. The name can contain only alphanumeric\n characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic\n character and can't be longer than 100 characters.
", - "smithy.api#required": {} - } - }, - "term": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionTerm", - "traits": { - "smithy.api#documentation": "An object representing the term duration and term unit type of your subscription. This\n determines the term length of your subscription. Valid values are MONTHS for term unit\n and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This\n value cannot be changed after creating the subscription.
", - "smithy.api#required": {} - } - }, - "licenseQuantity": { - "target": "com.amazonaws.eks#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of licenses to purchase with the subscription. Valid values are between 1\n and 100. This value can't be changed after creating the subscription.
" - } - }, - "licenseType": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType", - "traits": { - "smithy.api#documentation": "The license type for all licenses in the subscription. Valid value is CLUSTER. With\n the CLUSTER license type, each license covers support for a single EKS Anywhere\n cluster.
" - } - }, - "autoRenew": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A boolean indicating whether the subscription auto renews at the end of the\n term.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "The metadata for a subscription to assist with categorization and organization. Each\n tag consists of a key and an optional value. Subscription tags don't propagate to any\n other resources associated with the subscription.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#CreateEksAnywhereSubscriptionResponse": { - "type": "structure", - "members": { - "subscription": { - "target": "com.amazonaws.eks#EksAnywhereSubscription", - "traits": { - "smithy.api#documentation": "The full description of the subscription.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#CreateFargateProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#CreateFargateProfileRequest" - }, - "output": { - "target": "com.amazonaws.eks#CreateFargateProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#UnsupportedAvailabilityZoneException" - } - ], - "traits": { - "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\n Access Control (RBAC) for authorization so that the kubelet\n that is running on the Fargate infrastructure can register with your\n Amazon EKS cluster so that it can appear in your cluster as a node. The pod\n execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For\n more information, see Pod 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", - "code": 200 - } - } - }, - "com.amazonaws.eks#CreateFargateProfileRequest": { - "type": "structure", - "members": { - "fargateProfileName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Fargate profile.
", - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "podExecutionRoleArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod\n that matches the selectors in the Fargate profile. The Pod\n execution role allows Fargate infrastructure to register with your\n cluster as a node, and it provides read access to Amazon ECR image repositories.\n For more information, see \n Pod execution\n role in the Amazon EKS User Guide.
The IDs of subnets to launch a Pod into. A Pod running on\n Fargate isn't assigned a public IP address, so only private subnets\n (with no direct route to an Internet Gateway) are accepted for this parameter.
The selectors to match for a Pod to use this Fargate\n profile. Each selector must have an associated Kubernetes namespace. Optionally,\n you can also specify labels for a namespace. You may specify\n up to five selectors in a Fargate profile.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#CreateFargateProfileResponse": { - "type": "structure", - "members": { - "fargateProfile": { - "target": "com.amazonaws.eks#FargateProfile", - "traits": { - "smithy.api#documentation": "The full description of your new Fargate profile.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#CreateNodegroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#CreateNodegroupRequest" - }, - "output": { - "target": "com.amazonaws.eks#CreateNodegroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a managed node group for an Amazon EKS cluster.
\nYou can only create a node group for your cluster that is equal to the current Kubernetes\n version for the cluster. All node groups are created with the latest AMI release version\n for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI\n using 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. For more information, see\n Managed node groups in the Amazon EKS User Guide.
\nWindows AMI types are only supported for commercial Amazon Web Services Regions\n that support Windows on Amazon EKS.
\nThe name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The unique name to give your node group.
", - "smithy.api#required": {} - } - }, - "scalingConfig": { - "target": "com.amazonaws.eks#NodegroupScalingConfig", - "traits": { - "smithy.api#documentation": "The scaling configuration details for the Auto Scaling group that is created for your\n node group.
" - } - }, - "diskSize": { - "target": "com.amazonaws.eks#BoxedInteger", - "traits": { - "smithy.api#documentation": "The root device disk size (in GiB) for your node group instances. The default disk\n size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows.\n If you specify launchTemplate, then don't specify diskSize, 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 subnets to use for the Auto Scaling group that is created for your node group.\n If you specify launchTemplate, then don't specify \n SubnetId\n in your launch template, 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.
Specify the instance types for a node group. If you specify a GPU instance type, make\n sure to also specify an applicable GPU AMI type with the amiType parameter.\n If you specify launchTemplate, then you can specify zero or one instance\n type in your launch template or you can specify 0-20 instance types\n for instanceTypes. If however, you specify an instance type in your launch\n template and specify any instanceTypes, the node group\n deployment will fail. If you don't specify an instance type in a launch template or for\n instanceTypes, then t3.medium is used, by default. If you\n specify Spot for capacityType, then we recommend specifying\n multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in\n the Amazon EKS User Guide.
The AMI type for your node group. 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. If your launch template uses a Windows custom AMI, then add\n eks:kube-proxy-windows to your Windows nodes rolearn in\n the aws-auth\n ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The remote access configuration to use with your node group. For Linux, the protocol\n is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don't specify \n remoteAccess, or the node group deployment will fail.\n 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, 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 Kubernetes labels to apply to the nodes in the node group when they are\n created.
The Kubernetes taints to be applied to the nodes in the node group. For more information,\n see Node taints on\n managed node groups.
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "launchTemplate": { - "target": "com.amazonaws.eks#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "An object representing a node group's launch template specification. If specified,\n then do not specify instanceTypes, diskSize, or\n remoteAccess and make sure that the launch template meets the\n requirements in launchTemplateSpecification.
The node group update configuration.
" - } - }, - "capacityType": { - "target": "com.amazonaws.eks#CapacityTypes", - "traits": { - "smithy.api#documentation": "The capacity type for your node group.
" - } - }, - "version": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the\n cluster is used, and this is the only accepted specified value. If you specify launchTemplate,\n and your launch template uses a custom AMI, then don't specify version, 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 version\n is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.
\nIf you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group deployment will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The full description of your new node group.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#CreatePodIdentityAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#CreatePodIdentityAssociationRequest" - }, - "output": { - "target": "com.amazonaws.eks#CreatePodIdentityAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role\n with EKS Pod Identity. Use EKS Pod Identity to give temporary IAM credentials to\n pods and the credentials are rotated automatically.
\nAmazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
\nIf a pod uses a service account that has an association, Amazon EKS sets environment variables\n in the containers of the pod. The environment variables configure the Amazon Web Services SDKs,\n including the Command Line Interface, to use the EKS Pod Identity credentials.
\nPod Identity is a simpler method than IAM roles for service\n accounts, as this method doesn't use OIDC identity providers.\n Additionally, you can configure a role for Pod Identity once, and reuse it across\n clusters.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/pod-identity-associations", - "code": 200 - } - } - }, - "com.amazonaws.eks#CreatePodIdentityAssociationRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the cluster to create the association in.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "namespace": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.
", - "smithy.api#required": {} - } - }, - "serviceAccount": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
", - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\n agent manages credentials to assume this role for applications in the containers in the\n pods that use this service account.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
\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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The full description of your new association.
\nThe description includes an ID for the association. Use the ID of the association in further\n actions to manage the association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DeleteAccessEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DeleteAccessEntryRequest" - }, - "output": { - "target": "com.amazonaws.eks#DeleteAccessEntryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an access entry.
\nDeleting an access entry of a type other than Standard can cause your\n cluster to function improperly. If you delete an access entry in error, you can recreate\n it.
The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
Deletes an Amazon EKS add-on.
\nWhen you remove an add-on, it's deleted from the cluster. You can always manually\n start an add-on on the cluster using the Kubernetes API.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/clusters/{clusterName}/addons/{addonName}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DeleteAddonRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#ClusterName", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n .
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 isn't removed.
", - "smithy.api#httpQuery": "preserve" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DeleteAddonResponse": { - "type": "structure", - "members": { - "addon": { - "target": "com.amazonaws.eks#Addon" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DeleteCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DeleteClusterRequest" - }, - "output": { - "target": "com.amazonaws.eks#DeleteClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an 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\n DeleteNodgroup and DeleteFargateProfile.
Updates an access entry.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/access-entries/{principalArn}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateAccessEntryRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "principalArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The value for name that you've specified for kind: Group as\n a subject in a Kubernetes RoleBinding or\n ClusterRoleBinding object. Amazon EKS doesn't confirm that the\n value for name exists in any bindings on your cluster. You can specify one\n or more names.
Kubernetes authorizes the principalArn of the access entry to access any\n cluster objects that you've specified in a Kubernetes Role or\n ClusterRole object that is also specified in a binding's\n roleRef. For more information about creating Kubernetes\n RoleBinding, ClusterRoleBinding, Role, or\n ClusterRole objects, see Using RBAC\n Authorization in the Kubernetes documentation.
If you want Amazon EKS to authorize the principalArn (instead of,\n or in addition to Kubernetes authorizing the principalArn), you can associate\n one or more access policies to the access entry using\n AssociateAccessPolicy. If you associate any access policies, the\n principalARN has all permissions assigned in the associated access\n policies and all permissions in any Kubernetes Role or ClusterRole\n objects that the group names are bound to.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "username": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The username to authenticate to Kubernetes with. We recommend not specifying a username and\n letting Amazon EKS specify it for you. For more information about the value\n Amazon EKS specifies for you, or constraints before specifying your own\n username, see Creating\n access entries in the Amazon EKS User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateAccessEntryResponse": { + "type": "structure", + "members": { + "accessEntry": { + "target": "com.amazonaws.eks#AccessEntry", + "traits": { + "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The name of the cluster to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DeleteClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.eks#Cluster", - "traits": { - "smithy.api#documentation": "The full description of the cluster to delete.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DeleteEksAnywhereSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DeleteEksAnywhereSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.eks#DeleteEksAnywhereSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an expired or inactive subscription. Deleting inactive subscriptions removes\n them from the Amazon Web Services Management Console view and from list/describe API responses.\n Subscriptions can only be cancelled within 7 days of creation and are cancelled by\n creating a ticket in the Amazon Web Services Support Center.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/eks-anywhere-subscriptions/{id}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DeleteEksAnywhereSubscriptionRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the subscription.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DeleteEksAnywhereSubscriptionResponse": { - "type": "structure", - "members": { - "subscription": { - "target": "com.amazonaws.eks#EksAnywhereSubscription", - "traits": { - "smithy.api#documentation": "The full description of the subscription to be deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DeleteFargateProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DeleteFargateProfileRequest" - }, - "output": { - "target": "com.amazonaws.eks#DeleteFargateProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an Fargate profile.
\nWhen you delete a Fargate profile, any Pod running on\n Fargate that was created with the profile is deleted. If the\n Pod matches another Fargate profile, then it is\n scheduled on Fargate with that profile. If it no longer matches any\n Fargate profiles, then it's not scheduled on Fargate\n and may remain in a pending state.
Only 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 your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fargateProfileName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Fargate profile to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DeleteFargateProfileResponse": { - "type": "structure", - "members": { - "fargateProfile": { - "target": "com.amazonaws.eks#FargateProfile", - "traits": { - "smithy.api#documentation": "The deleted Fargate profile.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DeleteNodegroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DeleteNodegroupRequest" - }, - "output": { - "target": "com.amazonaws.eks#DeleteNodegroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a managed node group.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DeleteNodegroupRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the node group to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DeleteNodegroupResponse": { - "type": "structure", - "members": { - "nodegroup": { - "target": "com.amazonaws.eks#Nodegroup", - "traits": { - "smithy.api#documentation": "The full description of your deleted node group.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DeletePodIdentityAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DeletePodIdentityAssociationRequest" - }, - "output": { - "target": "com.amazonaws.eks#DeletePodIdentityAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a EKS Pod Identity association.
\nThe temporary Amazon Web Services credentials from the previous IAM role session might still be valid until the session expiry. If you need to immediately revoke the temporary session credentials, then go to the role in the IAM console.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/clusters/{clusterName}/pod-identity-associations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DeletePodIdentityAssociationRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The cluster name that
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the association to be deleted.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DeletePodIdentityAssociationResponse": { - "type": "structure", - "members": { - "association": { - "target": "com.amazonaws.eks#PodIdentityAssociation", - "traits": { - "smithy.api#documentation": "The full description of the EKS Pod Identity association that was deleted.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DeregisterCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DeregisterClusterRequest" - }, - "output": { - "target": "com.amazonaws.eks#DeregisterClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#AccessDeniedException" - }, - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Deregisters a connected cluster to remove it from the Amazon EKS control\n plane.
\nA connected cluster is a Kubernetes cluster that you've connected to your control plane\n using the Amazon EKS Connector.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/cluster-registrations/{name}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DeregisterClusterRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the connected cluster to deregister.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DeregisterClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.eks#Cluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeAccessEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribeAccessEntryRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribeAccessEntryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes an access entry.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/access-entries/{principalArn}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DescribeAccessEntryRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
Information about the access entry.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeAddon": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribeAddonRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribeAddonResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes an Amazon EKS add-on.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/addons/{addonName}", - "code": 200 - }, - "smithy.waiters#waitable": { - "AddonActive": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "addon.status", - "expected": "CREATE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "addon.status", - "expected": "DEGRADED", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "addon.status", - "expected": "ACTIVE", - "comparator": "stringEquals" - } - } - } + "target": "com.amazonaws.eks#UpdateAddonRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateAddonResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } ], - "minDelay": 10 - }, - "AddonDeleted": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "addon.status", - "expected": "DELETE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - } + "traits": { + "smithy.api#documentation": "Updates an Amazon EKS add-on.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/addons/{addonName}/update", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateAddonRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#ClusterName", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "addonName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n .
The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.
\nTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.
\nHow to resolve field value conflicts for an Amazon EKS add-on if you've\n changed a value from the Amazon EKS default value. Conflicts are handled based\n on the option you choose:
\n\n None – Amazon EKS doesn't\n change the value. The update might fail.
\n\n Overwrite – Amazon EKS\n overwrites the changed value back to the Amazon EKS default\n value.
\n\n Preserve – Amazon EKS\n preserves the value. If you choose this option, we recommend that you test any\n field and value changes on a non-production cluster before updating the add-on\n on your production cluster.
\nA unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "configurationValues": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.
Returns configuration options.
", - "smithy.api#http": { - "method": "GET", - "uri": "/addons/configuration-schemas", - "code": 200 - } - } - }, - "com.amazonaws.eks#DescribeAddonConfigurationRequest": { - "type": "structure", - "members": { - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by\n DescribeAddonVersions.
The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
The name of the add-on.
" - } - }, - "addonVersion": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
A JSON schema that's used to validate the configuration values you provide when an\n add-on is created or updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeAddonRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#ClusterName", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n .
Describes the versions for an add-on.
\nInformation such as the Kubernetes versions that you can use the add-on with, the\n owner, publisher, and the type of the add-on\n are returned.
The Kubernetes versions that you can use the add-on with.
", - "smithy.api#httpQuery": "kubernetesVersion" - } - }, - "maxResults": { - "target": "com.amazonaws.eks#DescribeAddonVersionsRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe name of the add-on. The name must match one of the names returned by \n ListAddons\n .
The type of the add-on. For valid types, don't specify a value for this\n property.
The publisher of the add-on. For valid publishers, don't specify a value\n for this property.
The owner of the add-on. For valid owners, don't specify a value for this\n property.
The list of available versions with Kubernetes version compatibility and other\n properties.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future\n DescribeAddonVersions request. When the results of a\n DescribeAddonVersions request exceed maxResults, you can\n use this value to retrieve the next page of results. This value is null\n when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nDescribes an Amazon EKS cluster.
\nThe API server endpoint and certificate authority data returned by this operation are\n required for kubelet and kubectl to communicate with your\n Kubernetes API server. For more information, see Creating or\n updating a kubeconfig file for an Amazon EKS\n cluster.
The API server endpoint and certificate authority data aren't available until the\n cluster reaches the ACTIVE state.
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 DescribeUpdate\"/>.
You can use this API operation to enable or disable exporting the Kubernetes control plane\n logs for your cluster to CloudWatch Logs. By default, cluster control plane logs\n 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 also use this API operation to choose different subnets and security groups\n for the cluster. You must specify at least two subnets that are in different\n Availability Zones. You can't change which VPC the subnets are from, the subnets must be\n in the same VPC as the subnets that the cluster was created with. For more information\n about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the \n Amazon EKS User Guide\n .
\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.
The name of the Amazon EKS cluster to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "resourcesVpcConfig": { + "target": "com.amazonaws.eks#VpcConfigRequest" + }, + "logging": { + "target": "com.amazonaws.eks#Logging", + "traits": { + "smithy.api#documentation": "Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see 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.
\nA unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "accessConfig": { + "target": "com.amazonaws.eks#UpdateAccessConfigRequest", + "traits": { + "smithy.api#documentation": "The access configuration for the cluster.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateClusterConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateClusterVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateClusterVersionRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdateClusterVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster\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 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’ Kubernetes\n versions must match the cluster’s Kubernetes version in order to update the cluster to a new\n Kubernetes version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{name}/updates", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateClusterVersionRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon EKS cluster to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The desired Kubernetes version following a successful update.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateClusterVersionResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update", + "traits": { + "smithy.api#documentation": "The full description of the specified update
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateEksAnywhereSubscription": { + "type": "operation", "input": { - "name": "devel" + "target": "com.amazonaws.eks#UpdateEksAnywhereSubscriptionRequest" }, "output": { - "cluster": { - "name": "devel", - "arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel", - "createdAt": 1.527807879988e9, - "version": "1.10", - "endpoint": "https://A0DCCD80A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com", - "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", - "resourcesVpcConfig": { - "subnetIds": ["subnet-6782e71e", "subnet-e7e761ac"], - "securityGroupIds": ["sg-6979fe18"], - "vpcId": "vpc-950809ec" + "target": "com.amazonaws.eks#UpdateEksAnywhereSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" }, - "status": "ACTIVE", - "certificateAuthority": { - "data": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=" - } - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{name}", - "code": 200 - }, - "smithy.waiters#waitable": { - "ClusterActive": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "cluster.status", - "expected": "DELETING", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "cluster.status", - "expected": "FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "cluster.status", - "expected": "ACTIVE", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - }, - "ClusterDeleted": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "cluster.status", - "expected": "ACTIVE", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "cluster.status", - "expected": "CREATING", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "cluster.status", - "expected": "PENDING", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.eks#DescribeClusterRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DescribeClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.eks#Cluster", - "traits": { - "smithy.api#documentation": "The full description of your specified cluster.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeEksAnywhereSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribeEksAnywhereSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribeEksAnywhereSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Returns descriptive information about a subscription.
", - "smithy.api#http": { - "method": "GET", - "uri": "/eks-anywhere-subscriptions/{id}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DescribeEksAnywhereSubscriptionRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the subscription.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DescribeEksAnywhereSubscriptionResponse": { - "type": "structure", - "members": { - "subscription": { - "target": "com.amazonaws.eks#EksAnywhereSubscription", - "traits": { - "smithy.api#documentation": "The full description of the subscription.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeFargateProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribeFargateProfileRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribeFargateProfileResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes an Fargate profile.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/fargate-profiles/{fargateProfileName}", - "code": 200 - }, - "smithy.waiters#waitable": { - "FargateProfileActive": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "fargateProfile.status", - "expected": "CREATE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "fargateProfile.status", - "expected": "ACTIVE", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 10 - }, - "FargateProfileDeleted": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "fargateProfile.status", - "expected": "DELETE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.eks#DescribeFargateProfileRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "fargateProfileName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Fargate profile to describe.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DescribeFargateProfileResponse": { - "type": "structure", - "members": { - "fargateProfile": { - "target": "com.amazonaws.eks#FargateProfile", - "traits": { - "smithy.api#documentation": "The full description of your Fargate profile.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeIdentityProviderConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribeIdentityProviderConfigRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribeIdentityProviderConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Describes an identity provider configuration.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/identity-provider-configs/describe", - "code": 200 - } - } - }, - "com.amazonaws.eks#DescribeIdentityProviderConfigRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "identityProviderConfig": { - "target": "com.amazonaws.eks#IdentityProviderConfig", - "traits": { - "smithy.api#documentation": "An object representing an identity provider configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DescribeIdentityProviderConfigResponse": { - "type": "structure", - "members": { - "identityProviderConfig": { - "target": "com.amazonaws.eks#IdentityProviderConfigResponse", - "traits": { - "smithy.api#documentation": "The object that represents an OpenID Connect (OIDC) identity provider\n configuration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeNodegroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribeNodegroupRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribeNodegroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Describes a managed node group.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}", - "code": 200 - }, - "smithy.waiters#waitable": { - "NodegroupActive": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "nodegroup.status", - "expected": "CREATE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "output": { - "path": "nodegroup.status", - "expected": "ACTIVE", - "comparator": "stringEquals" - } - } - } + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } ], - "minDelay": 30 - }, - "NodegroupDeleted": { - "acceptors": [ - { - "state": "failure", - "matcher": { - "output": { - "path": "nodegroup.status", - "expected": "DELETE_FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - } + "traits": { + "smithy.api#documentation": "Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after\n subscription creation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/eks-anywhere-subscriptions/{id}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateEksAnywhereSubscriptionRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "autoRenew": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean indicating whether or not to automatically renew the subscription.
", + "smithy.api#required": {} + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateEksAnywhereSubscriptionResponse": { + "type": "structure", + "members": { + "subscription": { + "target": "com.amazonaws.eks#EksAnywhereSubscription", + "traits": { + "smithy.api#documentation": "The full description of the updated subscription.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateLabelsPayload": { + "type": "structure", + "members": { + "addOrUpdateLabels": { + "target": "com.amazonaws.eks#labelsMap", + "traits": { + "smithy.api#documentation": "The Kubernetes labels to add or update.
The Kubernetes labels to remove.
An object representing a Kubernetes label change for a managed node\n group.
The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the node group to describe.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DescribeNodegroupResponse": { - "type": "structure", - "members": { - "nodegroup": { - "target": "com.amazonaws.eks#Nodegroup", - "traits": { - "smithy.api#documentation": "The full description of your node group.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribePodIdentityAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribePodIdentityAssociationRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribePodIdentityAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Returns descriptive information about an EKS Pod Identity association.
\nThis action requires the ID of the association. You can get the ID from the response to\n the CreatePodIdentityAssocation for newly created associations. Or, you can\n list the IDs for associations with ListPodIdentityAssociations and filter the\n list by namespace or service account.
The name of the cluster that the association is in.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the association that you want the description of.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DescribePodIdentityAssociationResponse": { - "type": "structure", - "members": { - "association": { - "target": "com.amazonaws.eks#PodIdentityAssociation", - "traits": { - "smithy.api#documentation": "The full description of the EKS Pod Identity association.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DescribeUpdate": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DescribeUpdateRequest" - }, - "output": { - "target": "com.amazonaws.eks#DescribeUpdateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Describes an update to an Amazon EKS resource.
\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.
The name of the Amazon EKS cluster associated with the update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "updateId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the update to describe.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Amazon EKS node group associated with the update. This\n parameter is required if the update is a node group update.
", - "smithy.api#httpQuery": "nodegroupName" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n . This parameter is required if the update is an add-on update.
Describes an update request.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DescribeUpdateResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update", - "traits": { - "smithy.api#documentation": "The full description of the specified update.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#DisassociateAccessPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#DisassociateAccessPolicyRequest" - }, - "output": { - "target": "com.amazonaws.eks#DisassociateAccessPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates an access policy from an access entry.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies/{policyArn}", - "code": 200 - } - } - }, - "com.amazonaws.eks#DisassociateAccessPolicyRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The ARN of the policy to disassociate from the access entry. For a list of\n associated policies ARNs, use ListAssociatedAccessPolicies.
Disassociates an identity provider configuration from a cluster.
\nIf you disassociate an identity provider from your cluster, users included in the\n provider can no longer access the cluster. However, you can still access the cluster\n with IAM principals.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/identity-provider-configs/disassociate", - "code": 200 - } - } - }, - "com.amazonaws.eks#DisassociateIdentityProviderConfigRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "identityProviderConfig": { - "target": "com.amazonaws.eks#IdentityProviderConfig", - "traits": { - "smithy.api#documentation": "An object representing an identity provider configuration.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#DisassociateIdentityProviderConfigResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#EksAnywhereSubscription": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "UUID identifying a subscription.
" - } - }, - "arn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the subscription.
" - } - }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp in seconds for when the subscription was created.
" - } - }, - "effectiveDate": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp in seconds for when the subscription is effective.
" - } - }, - "expirationDate": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp in seconds for when the subscription will expire or auto renew,\n depending on the auto renew configuration of the subscription object.
" - } - }, - "licenseQuantity": { - "target": "com.amazonaws.eks#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of licenses included in a subscription. Valid values are between 1 and\n 100.
" - } - }, - "licenseType": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType", - "traits": { - "smithy.api#documentation": "The type of licenses included in the subscription. Valid value is CLUSTER. With the\n CLUSTER license type, each license covers support for a single EKS Anywhere\n cluster.
" - } - }, - "term": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionTerm", - "traits": { - "smithy.api#documentation": "An EksAnywhereSubscriptionTerm object.
" - } - }, - "status": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The status of a subscription.
" - } - }, - "autoRenew": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A boolean indicating whether or not a subscription will auto renew when it\n expires.
" - } - }, - "licenseArns": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "Amazon Web Services License Manager ARN associated with the subscription.
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "The metadata for a subscription to assist with categorization and organization. Each\n tag consists of a key and an optional value. Subscription tags do not propagate to any\n other resources associated with the subscription.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An EKS Anywhere subscription authorizing the customer to support for licensed clusters\n and access to EKS Anywhere Curated Packages.
" - } - }, - "com.amazonaws.eks#EksAnywhereSubscriptionLicenseType": { - "type": "enum", - "members": { - "Cluster": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cluster" - } - } - } - }, - "com.amazonaws.eks#EksAnywhereSubscriptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#EksAnywhereSubscription" - } - }, - "com.amazonaws.eks#EksAnywhereSubscriptionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[0-9A-Za-z][A-Za-z0-9\\-_]*$" - } - }, - "com.amazonaws.eks#EksAnywhereSubscriptionStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "EXPIRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRING" - } - }, - "EXPIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPIRED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.eks#EksAnywhereSubscriptionStatusValues": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionStatus" - } - }, - "com.amazonaws.eks#EksAnywhereSubscriptionTerm": { - "type": "structure", - "members": { - "duration": { - "target": "com.amazonaws.eks#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The duration of the subscription term. Valid values are 12 and 36, indicating a 12 month or 36 month subscription.
" - } - }, - "unit": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionTermUnit", - "traits": { - "smithy.api#documentation": "The term unit of the subscription. Valid value is MONTHS.
An object representing the term duration and term unit type of your subscription. This\n determines the term length of your subscription. Valid values are MONTHS for term unit\n and 12 or 36 for term duration, indicating a 12 month or 36 month subscription.
" - } - }, - "com.amazonaws.eks#EksAnywhereSubscriptionTermUnit": { - "type": "enum", - "members": { - "MONTHS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTHS" - } - } - } - }, - "com.amazonaws.eks#EncryptionConfig": { - "type": "structure", - "members": { - "resources": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "Specifies the resources to be encrypted. The only supported value is\n secrets.
Key Management Service (KMS) key. Either the ARN or the alias can be\n used.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The encryption configuration for the cluster.
" - } - }, - "com.amazonaws.eks#EncryptionConfigList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#EncryptionConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.eks#ErrorCode": { - "type": "enum", - "members": { - "SUBNET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SubnetNotFound" - } - }, - "SECURITY_GROUP_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SecurityGroupNotFound" - } - }, - "ENI_LIMIT_REACHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EniLimitReached" - } - }, - "IP_NOT_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IpNotAvailable" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessDenied" - } - }, - "OPERATION_NOT_PERMITTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OperationNotPermitted" - } - }, - "VPC_ID_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VpcIdNotFound" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - }, - "NODE_CREATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NodeCreationFailure" - } - }, - "POD_EVICTION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PodEvictionFailure" - } - }, - "INSUFFICIENT_FREE_ADDRESSES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InsufficientFreeAddresses" - } - }, - "CLUSTER_UNREACHABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClusterUnreachable" - } - }, - "INSUFFICIENT_NUMBER_OF_REPLICAS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InsufficientNumberOfReplicas" - } - }, - "CONFIGURATION_CONFLICT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ConfigurationConflict" - } - }, - "ADMISSION_REQUEST_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AdmissionRequestDenied" - } - }, - "UNSUPPORTED_ADDON_MODIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnsupportedAddonModification" - } - }, - "K8S_RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "K8sResourceNotFound" - } - } - } - }, - "com.amazonaws.eks#ErrorDetail": { - "type": "structure", - "members": { - "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 available 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 more complete description of the error.
" - } - }, - "resourceIds": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "An optional field that contains the resource IDs associated with the error.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an error when an asynchronous operation fails.
" - } - }, - "com.amazonaws.eks#ErrorDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#ErrorDetail" - } - }, - "com.amazonaws.eks#FargateProfile": { - "type": "structure", - "members": { - "fargateProfileName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Fargate profile.
" - } - }, - "fargateProfileArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the Fargate profile.
" - } - }, - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
" - } - }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" - } - }, - "podExecutionRoleArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Pod execution role to use for any Pod\n that matches the selectors in the Fargate profile. For more information,\n see \n Pod execution role in the Amazon EKS User Guide.
The IDs of subnets to launch a Pod into.
The selectors to match for a Pod to use this Fargate\n profile.
The current status of the Fargate profile.
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an Fargate profile.
" - } - }, - "com.amazonaws.eks#FargateProfileLabel": { - "type": "map", - "key": { - "target": "com.amazonaws.eks#String" - }, - "value": { - "target": "com.amazonaws.eks#String" - } - }, - "com.amazonaws.eks#FargateProfileSelector": { - "type": "structure", - "members": { - "namespace": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Kubernetes namespace that the selector should match.
The Kubernetes labels that the selector should match. A pod must contain all of the labels\n that are specified in the selector for it to be considered a match.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an Fargate profile selector.
" - } - }, - "com.amazonaws.eks#FargateProfileSelectors": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#FargateProfileSelector" - } - }, - "com.amazonaws.eks#FargateProfileStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.eks#FargateProfilesRequestMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.eks#Identity": { - "type": "structure", - "members": { - "oidc": { - "target": "com.amazonaws.eks#OIDC", - "traits": { - "smithy.api#documentation": "An object representing the OpenID Connect\n identity provider information.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an identity provider.
" - } - }, - "com.amazonaws.eks#IdentityProviderConfig": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The type of the identity provider configuration. The only type available is\n oidc.
The name of the identity provider configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an identity provider configuration.
" - } - }, - "com.amazonaws.eks#IdentityProviderConfigResponse": { - "type": "structure", - "members": { - "oidc": { - "target": "com.amazonaws.eks#OidcIdentityProviderConfig", - "traits": { - "smithy.api#documentation": "An object representing an OpenID Connect (OIDC) identity provider configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The full description of your identity configuration.
" - } - }, - "com.amazonaws.eks#IdentityProviderConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#IdentityProviderConfig" - } - }, - "com.amazonaws.eks#IncludeClustersList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#String" - } - }, - "com.amazonaws.eks#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.eks#InvalidParameterException": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "fargateProfileName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Fargate profile associated with the exception.
" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The specified parameter for the add-on name is invalid. Review the available\n parameters for the API request
" - } - }, - "subscriptionId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n request.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.eks#InvalidRequestException": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The request is invalid given the state of the add-on name. Check the state of the\n cluster and the associated operations.
" - } - }, - "subscriptionId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The request is invalid given the state of the cluster. Check the state of the cluster\n and the associated operations.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.eks#IpFamily": { - "type": "enum", - "members": { - "IPV4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ipv4" - } - }, - "IPV6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "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\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\n the Amazon 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\n this failure are insufficient node IAM\n role permissions or lack of outbound internet access for the nodes.\n
\nThe error message associated with the issue.
" - } - }, - "resourceIds": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The Amazon Web Services resources that are afflicted by this issue.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an issue with an Amazon EKS resource.
" - } - }, - "com.amazonaws.eks#IssueList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#Issue" - } - }, - "com.amazonaws.eks#KubernetesNetworkConfigRequest": { - "type": "structure", - "members": { - "serviceIpv4Cidr": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "Don't specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from. If\n you don't specify a block, Kubernetes assigns addresses from either the\n 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend\n that you specify a block that does not overlap with resources in other networks that are\n peered or connected to your VPC. The block must meet the following requirements:
Within one of the following private IP address blocks:\n 10.0.0.0/8, 172.16.0.0/12, or\n 192.168.0.0/16.
Doesn't overlap with any CIDR block assigned to the VPC that you selected for\n VPC.
\nBetween /24 and /12.
You can only specify a custom CIDR block when you create a cluster. You can't\n change this value after the cluster is created.
\nSpecify which IP family is used to assign Kubernetes pod and service IP addresses. If you\n don't specify a value, ipv4 is used by default. You can only specify an IP\n 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\n assigned to them. You can't specify ipv6 for clusters in China\n Regions.
You can only specify ipv6 for 1.21 and later clusters that\n use version 1.10.1 or later of the Amazon VPC CNI add-on. If you specify\n ipv6, then ensure that your VPC meets the requirements listed in the\n considerations listed in Assigning IPv6 addresses to pods and\n services in the Amazon EKS User Guide. Kubernetes assigns services\n IPv6 addresses from the unique local address range\n (fc00::/7). You can't specify a custom IPv6 CIDR block.\n Pod addresses are assigned from the subnet's IPv6 CIDR.
The Kubernetes network configuration for the cluster.
" - } - }, - "com.amazonaws.eks#KubernetesNetworkConfigResponse": { - "type": "structure", - "members": { - "serviceIpv4Cidr": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The CIDR block that Kubernetes Pod and Service object IP\n addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR\n block assigned to a subnet that the node is in. If you didn't specify a CIDR block when\n you created the cluster, then Kubernetes assigns addresses from either the\n 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was\n specified, then it was specified when the cluster was created and it can't be\n changed.
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.1 or later of the Amazon VPC CNI add-on and\n specified ipv6 for ipFamily when you\n created the cluster. Kubernetes assigns service addresses from the unique local address range\n (fc00::/7) because you can't specify a custom IPv6 CIDR block when you\n create the cluster.
The IP family used to assign Kubernetes Pod and Service objects\n IP addresses. The IP family is always ipv4, unless you have a\n 1.21 or later cluster running version 1.10.1 or later of\n the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.\n
The Kubernetes network configuration for the cluster. The response contains a value for\n serviceIpv6Cidr or serviceIpv4Cidr, but not both.
" - } - }, - "com.amazonaws.eks#LaunchTemplateSpecification": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the launch template.
\nYou must specify either the launch template name or the launch template ID in the\n request, but not both.
" - } - }, - "version": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The version number of the launch template to use. If no version is specified, then the\n template's default version is used.
" - } - }, - "id": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the launch template.
\nYou must specify either the launch template ID or the launch template name in the\n request, but not both.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing a node group launch template specification. The launch template\n can't 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.
You must specify either the launch template ID or the launch template name in the\n request, but not both.
" - } - }, - "com.amazonaws.eks#ListAccessEntries": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#ListAccessEntriesRequest" - }, - "output": { - "target": "com.amazonaws.eks#ListAccessEntriesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the access entries for your cluster.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/access-entries", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "accessEntries", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListAccessEntriesRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associatedPolicyArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of an AccessPolicy. When you specify an access policy ARN,\n only the access entries associated to that access policy are returned. For a list of\n available policy ARNs, use ListAccessPolicies.
The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of access entries that exist for the cluster.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the available access policies.
", - "smithy.api#http": { - "method": "GET", - "uri": "/access-policies", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "accessPolicies", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListAccessPoliciesRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.eks#ListAccessPoliciesRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of available access policies. You can't view the contents of an access policy\n using the API. To view the contents, see Access\n policy permissions in the Amazon EKS User Guide.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the installed add-ons.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/addons", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "addons", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListAddonsRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#ClusterName", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.eks#ListAddonsRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of installed add-ons.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future ListAddons\n request. When the results of a ListAddons request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the access policies associated with an access entry.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/access-entries/{principalArn}/access-policies", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "associatedAccessPolicies", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListAssociatedAccessPoliciesRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe name of your cluster.
" - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of access policies associated with the access entry.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#ListClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#ListClustersRequest" - }, - "output": { - "target": "com.amazonaws.eks#ListClustersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the Amazon EKS clusters in your Amazon Web Services account in the\n specified Amazon Web Services Region.
", - "smithy.api#examples": [ - { - "title": "To list your available clusters", - "documentation": "This example command lists all of your available clusters in your default region.", + "traits": { + "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 labels\n for a node group or the scaling configuration.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-config", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdateNodegroupConfigRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the managed node group to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "labels": { + "target": "com.amazonaws.eks#UpdateLabelsPayload", + "traits": { + "smithy.api#documentation": "The Kubernetes labels to apply to the nodes in the node group after the\n update.
The Kubernetes taints to be applied to the nodes in the node group after the update. For\n more information, see Node taints on\n managed node groups.
" + } + }, + "scalingConfig": { + "target": "com.amazonaws.eks#NodegroupScalingConfig", + "traits": { + "smithy.api#documentation": "The scaling configuration details for the Auto Scaling group after the update.
" + } + }, + "updateConfig": { + "target": "com.amazonaws.eks#NodegroupUpdateConfig", + "traits": { + "smithy.api#documentation": "The node group update configuration.
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateNodegroupConfigResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateNodegroupVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.eks#UpdateNodegroupVersionRequest" + }, "output": { - "clusters": ["devel", "prod"] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/clusters", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "clusters", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListClustersRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.eks#ListClustersRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nIndicates whether external clusters are included in the returned list. Use\n 'all' to return https://docs.aws.amazon.com/eks/latest/userguide/eks-connector.htmlconnected clusters, or blank to\n return only Amazon EKS clusters. 'all' must be in lowercase\n otherwise an error occurs.
A list of all of the clusters for your account in the specified Amazon Web Services Region.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nDisplays the full description of the subscription.
", - "smithy.api#http": { - "method": "GET", - "uri": "/eks-anywhere-subscriptions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "subscriptions", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequest": { - "type": "structure", - "members": { - "maxResults": { - "target": "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of cluster results returned by ListEksAnywhereSubscriptions in\n paginated output. When you use this parameter, ListEksAnywhereSubscriptions returns only\n maxResults results in a single page along with a nextToken response element. You can see\n the remaining results of the initial request by sending another\n ListEksAnywhereSubscriptions request with the returned nextToken value. This value can\n be between 1 and 100. If you don't use this parameter, ListEksAnywhereSubscriptions\n returns up to 10 results and a nextToken value if applicable.
", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated\n ListEksAnywhereSubscriptions request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.
An array of subscription statuses to filter on.
", - "smithy.api#httpQuery": "includeStatus" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#ListEksAnywhereSubscriptionsRequestMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.eks#ListEksAnywhereSubscriptionsResponse": { - "type": "structure", - "members": { - "subscriptions": { - "target": "com.amazonaws.eks#EksAnywhereSubscriptionList", - "traits": { - "smithy.api#documentation": "A list of all subscription objects in the region, filtered by includeStatus and\n paginated by nextToken and maxResults.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future ListEksAnywhereSubscriptions request. When\n the results of a ListEksAnywhereSubscriptions request exceed maxResults, you can use\n this value to retrieve the next page of results. This value is null when there are no\n more results to return.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#ListFargateProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#ListFargateProfilesRequest" - }, - "output": { - "target": "com.amazonaws.eks#ListFargateProfilesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the Fargate profiles associated with the specified cluster in\n your Amazon Web Services account in the specified Amazon Web Services Region.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/fargate-profiles", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "fargateProfileNames", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListFargateProfilesRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.eks#FargateProfilesRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of all of the Fargate profiles associated with the specified\n cluster.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nLists the identity provider configurations for your cluster.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/identity-provider-configs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "identityProviderConfigs", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListIdentityProviderConfigsRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.eks#ListIdentityProviderConfigsRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe identity provider configurations for the cluster.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value to include in a future\n ListIdentityProviderConfigsResponse request. When the results of a\n ListIdentityProviderConfigsResponse request exceed\n maxResults, you can use this value to retrieve the next page of\n results. This value is null when there are no more results to\n return.
Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node\n groups aren't listed.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/node-groups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "nodegroups", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListNodegroupsRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.eks#ListNodegroupsRequestMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nA list of all of the node groups associated with the specified cluster.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nList the EKS Pod Identity associations in a cluster. You can filter the list by the namespace that the\n association is in or the service account that the association uses.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{clusterName}/pod-identity-associations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "associations", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListPodIdentityAssociationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.eks#ListPodIdentityAssociationsRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the cluster that the associations are in.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "namespace": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster that the associations are in.
", - "smithy.api#httpQuery": "namespace" - } - }, - "serviceAccount": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes service account that the associations use.
", - "smithy.api#httpQuery": "serviceAccount" - } - }, - "maxResults": { - "target": "com.amazonaws.eks#ListPodIdentityAssociationsMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of EKS Pod Identity association results returned by\n ListPodIdentityAssociations in paginated output. When you use this\n parameter, ListPodIdentityAssociations returns only maxResults\n results in a single page along with a nextToken response element. You can\n see the remaining results of the initial request by sending another\n ListPodIdentityAssociations request with the returned\n nextToken value. This value can be between 1 and\n 100. If you don't use this parameter,\n ListPodIdentityAssociations returns up to 100 results\n and a nextToken value if applicable.
The nextToken value returned from a previous paginated\n ListUpdates request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe list of summarized descriptions of the associations that are in the cluster and match any\n filters that you provided.
\nEach summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :
The IAM role: roleArn\n
The timestamp that the association was created at: createdAt\n
The most recent timestamp that the association was modified at:. modifiedAt\n
The tags on the association: tags\n
The nextToken value to include in a future\n ListPodIdentityAssociations request. When the results of a\n ListPodIdentityAssociations request exceed maxResults, you\n can use this value to retrieve the next page of results. This value is null\n when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nList the tags for an Amazon EKS resource.
", - "smithy.api#examples": [ - { - "title": "To list tags for a cluster", - "documentation": "This example lists all of the tags for the `beta` cluster.", + "target": "com.amazonaws.eks#UpdateNodegroupVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#ClientException" + }, + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceInUseException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "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 version in\n the request. You can update to the latest AMI version of your cluster's current Kubernetes\n version by specifying your cluster's Kubernetes version in the request. For information about\n Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the\n Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.
\nYou cannot roll back a node group to an earlier Kubernetes version or AMI version.
\nWhen a node in a managed node group is terminated due to a scaling action or update,\n every Pod on that node is drained first. Amazon EKS attempts to\n drain the nodes gracefully and will fail if it is unable to do so. You can\n force the update if Amazon EKS is unable to drain the nodes as\n a result of a Pod disruption budget issue.
The name of your cluster.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nodegroupName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the managed node group to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "version": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The Kubernetes version to update to. If no version is specified, then the Kubernetes version of\n the node group does not change. You can specify the Kubernetes version of the cluster to\n update the node group to the latest AMI version of the cluster's Kubernetes version.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\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.
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 used.\n For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.
\nIf 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.
An object representing a node group's launch template specification. You can only\n update a node group using a launch template if the node group was originally deployed\n with a launch template.
" + } + }, + "force": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Force the update if any Pod on the existing node group can't be drained\n due to a Pod disruption budget issue. If an update fails because all Pods\n can't be drained, you can force the update after it fails to terminate the old node\n whether or not any Pod is running on the node.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdateNodegroupVersionResponse": { + "type": "structure", + "members": { + "update": { + "target": "com.amazonaws.eks#Update" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateParam": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.eks#UpdateParamType", + "traits": { + "smithy.api#documentation": "The keys associated with an update request.
" + } + }, + "value": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The value of the keys submitted as part of an update request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the details of an update request.
" + } + }, + "com.amazonaws.eks#UpdateParamType": { + "type": "enum", + "members": { + "VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Version" + } + }, + "PLATFORM_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PlatformVersion" + } + }, + "ENDPOINT_PRIVATE_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndpointPrivateAccess" + } + }, + "ENDPOINT_PUBLIC_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndpointPublicAccess" + } + }, + "CLUSTER_LOGGING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterLogging" + } + }, + "DESIRED_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DesiredSize" + } + }, + "LABELS_TO_ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LabelsToAdd" + } + }, + "LABELS_TO_REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LabelsToRemove" + } + }, + "TAINTS_TO_ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaintsToAdd" + } + }, + "TAINTS_TO_REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TaintsToRemove" + } + }, + "MAX_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxSize" + } + }, + "MIN_SIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MinSize" + } + }, + "RELEASE_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReleaseVersion" + } + }, + "PUBLIC_ACCESS_CIDRS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PublicAccessCidrs" + } + }, + "LAUNCH_TEMPLATE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LaunchTemplateName" + } + }, + "LAUNCH_TEMPLATE_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LaunchTemplateVersion" + } + }, + "IDENTITY_PROVIDER_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IdentityProviderConfig" + } + }, + "ENCRYPTION_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EncryptionConfig" + } + }, + "ADDON_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonVersion" + } + }, + "SERVICE_ACCOUNT_ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceAccountRoleArn" + } + }, + "RESOLVE_CONFLICTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResolveConflicts" + } + }, + "MAX_UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxUnavailable" + } + }, + "MAX_UNAVAILABLE_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaxUnavailablePercentage" + } + }, + "CONFIGURATION_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigurationValues" + } + }, + "SECURITY_GROUPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecurityGroups" + } + }, + "SUBNETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Subnets" + } + }, + "AUTHENTICATION_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AuthenticationMode" + } + } + } + }, + "com.amazonaws.eks#UpdateParams": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#UpdateParam" + } + }, + "com.amazonaws.eks#UpdatePodIdentityAssociation": { + "type": "operation", "input": { - "resourceArn": "arn:aws:eks:us-west-2:012345678910:cluster/beta" + "target": "com.amazonaws.eks#UpdatePodIdentityAssociationRequest" + }, + "output": { + "target": "com.amazonaws.eks#UpdatePodIdentityAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.eks#InvalidParameterException" + }, + { + "target": "com.amazonaws.eks#InvalidRequestException" + }, + { + "target": "com.amazonaws.eks#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.eks#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved\n between clusters, namespaces, or service accounts. If you need to edit the namespace\n or service account, you need to delete the association and then create a new\n association with your desired settings.
", + "smithy.api#http": { + "method": "POST", + "uri": "/clusters/{clusterName}/pod-identity-associations/{associationId}", + "code": 200 + } + } + }, + "com.amazonaws.eks#UpdatePodIdentityAssociationRequest": { + "type": "structure", + "members": { + "clusterName": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The name of the cluster that you want to update the association in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationId": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The ID of the association to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The new IAM role to change the
" + } + }, + "clientRequestToken": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.eks#UpdatePodIdentityAssociationResponse": { + "type": "structure", + "members": { + "association": { + "target": "com.amazonaws.eks#PodIdentityAssociation", + "traits": { + "smithy.api#documentation": "The full description of the EKS Pod Identity association that was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.eks#UpdateStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Cancelled" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + } + } + }, + "com.amazonaws.eks#UpdateTaintsPayload": { + "type": "structure", + "members": { + "addOrUpdateTaints": { + "target": "com.amazonaws.eks#taintsList", + "traits": { + "smithy.api#documentation": "Kubernetes taints to be added or updated.
" + } + }, + "removeTaints": { + "target": "com.amazonaws.eks#taintsList", + "traits": { + "smithy.api#documentation": "Kubernetes taints to remove.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the details of an update to a taints payload. For more\n information, see Node taints on\n managed node groups in the Amazon EKS User Guide.
" + } + }, + "com.amazonaws.eks#UpdateType": { + "type": "enum", + "members": { + "VERSION_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VersionUpdate" + } + }, + "ENDPOINT_ACCESS_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EndpointAccessUpdate" + } + }, + "LOGGING_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LoggingUpdate" + } + }, + "CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ConfigUpdate" + } + }, + "ASSOCIATE_IDENTITY_PROVIDER_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociateIdentityProviderConfig" + } + }, + "DISASSOCIATE_IDENTITY_PROVIDER_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisassociateIdentityProviderConfig" + } + }, + "ASSOCIATE_ENCRYPTION_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AssociateEncryptionConfig" + } + }, + "ADDON_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AddonUpdate" + } + }, + "VPC_CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VpcConfigUpdate" + } + }, + "ACCESS_CONFIG_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessConfigUpdate" + } + } + } + }, + "com.amazonaws.eks#VpcConfigRequest": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "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\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. 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 Kubernetes\n API server endpoint. If you disable public access, your cluster's Kubernetes API server can\n only receive requests from within the cluster VPC. The default value for this parameter\n is true, which enables public access for your Kubernetes API server. For more\n information, see Amazon EKS cluster endpoint access control in\n the \n Amazon EKS User Guide\n .
Set this value to true to enable private access for your cluster's Kubernetes\n API server endpoint. If you enable private access, Kubernetes API requests from within your\n cluster's VPC use the private VPC endpoint. The default value for this parameter is\n false, which disables private access for your Kubernetes API server. If you\n 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\n 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, make sure that you specify the necessary CIDR blocks for every\n node and Fargate\n Pod in the cluster. For more information, 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\n cluster.
" + } + }, + "com.amazonaws.eks#VpcConfigResponse": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The subnets associated with your cluster.
" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.eks#StringList", + "traits": { + "smithy.api#documentation": "The security groups associated with the cross-account elastic network interfaces that\n are used to allow communication between your nodes and the Kubernetes control plane.
" + } + }, + "clusterSecurityGroupId": { + "target": "com.amazonaws.eks#String", + "traits": { + "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": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The VPC associated with your cluster.
" + } + }, + "endpointPublicAccess": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether the public API server endpoint is enabled.
" + } + }, + "endpointPrivateAccess": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "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 API\n 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.
" + } + } }, - "output": { - "tags": { - "aws:tag:domain": "beta" - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.eks#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource to list tags for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "The tags for the resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#ListUpdates": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#ListUpdatesRequest" - }, - "output": { - "target": "com.amazonaws.eks#ListUpdatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region.
", - "smithy.api#http": { - "method": "GET", - "uri": "/clusters/{name}/updates", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "updateIds", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.eks#ListUpdatesRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Amazon EKS cluster to list updates for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Amazon EKS managed node group to list updates for.
", - "smithy.api#httpQuery": "nodegroupName" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The names of the installed add-ons that have available updates.
", - "smithy.api#httpQuery": "addonName" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of results, returned in paginated output. You receive\n maxResults in a single page, along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another request with the returned nextToken value. This value can be\n between 1 and 100. If you don't use this parameter,\n 100 results and a nextToken value, if applicable, are\n returned.
A list of all the updates for the specified cluster and Region.
" - } - }, - "nextToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The nextToken value returned from a previous paginated request, where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of\n the previous results that returned the nextToken value. This value is null when there are no more results to return.
This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe available cluster control plane log types.
" - } - }, - "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 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.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the enabled or disabled Kubernetes control plane logs for your\n cluster.
" - } - }, - "com.amazonaws.eks#LogSetups": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#LogSetup" - } - }, - "com.amazonaws.eks#LogType": { - "type": "enum", - "members": { - "API": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "api" - } - }, - "AUDIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "audit" - } - }, - "AUTHENTICATOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "authenticator" - } - }, - "CONTROLLER_MANAGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "controllerManager" - } - }, - "SCHEDULER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "scheduler" - } - } - } - }, - "com.amazonaws.eks#LogTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#LogType" - } - }, - "com.amazonaws.eks#Logging": { - "type": "structure", - "members": { - "clusterLogging": { - "target": "com.amazonaws.eks#LogSetups", - "traits": { - "smithy.api#documentation": "The cluster control plane logging configuration for your cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the logging configuration for resources in your cluster.
" - } - }, - "com.amazonaws.eks#MarketplaceInformation": { - "type": "structure", - "members": { - "productId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The product ID from the Amazon Web Services Marketplace.
" - } - }, - "productUrl": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The product URL from the Amazon Web Services Marketplace.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about an Amazon EKS add-on from the Amazon Web Services Marketplace.
" - } - }, - "com.amazonaws.eks#Nodegroup": { - "type": "structure", - "members": { - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name associated with an Amazon EKS managed node group.
" - } - }, - "nodegroupArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the managed node group.
" - } - }, - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
" - } - }, - "version": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Kubernetes version of the managed node group.
" - } - }, - "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\n optimized AMI that the node group was deployed with.
" - } - }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" - } - }, - "modifiedAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp for the last modification to the object.
" - } - }, - "status": { - "target": "com.amazonaws.eks#NodegroupStatus", - "traits": { - "smithy.api#documentation": "The current status of the managed node group.
" - } - }, - "capacityType": { - "target": "com.amazonaws.eks#CapacityTypes", - "traits": { - "smithy.api#documentation": "The capacity type of your managed node group.
" - } - }, - "scalingConfig": { - "target": "com.amazonaws.eks#NodegroupScalingConfig", - "traits": { - "smithy.api#documentation": "The scaling configuration details for the Auto Scaling group that is associated with\n your node group.
" - } - }, - "instanceTypes": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "If the node group wasn't deployed with a launch template, then this is the instance\n type that is associated with the node group. If the node group was deployed with a\n launch template, then this is null.
The subnets that were specified for the Auto Scaling group that is associated with\n your node group.
" - } - }, - "remoteAccess": { - "target": "com.amazonaws.eks#RemoteAccessConfig", - "traits": { - "smithy.api#documentation": "If the node group wasn't deployed with a launch template, then this is the remote\n access configuration that is associated with the node group. If the node group was\n deployed with a launch template, then this is null.
If the node group was deployed using a launch template with a custom AMI, then this is\n CUSTOM. For node groups that weren't deployed using a launch template,\n this is the AMI type that was specified in the node group configuration.
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.
Only labels that are applied with the Amazon EKS API are\n shown here. There may be other Kubernetes labels applied to the nodes in\n this group.
The Kubernetes taints to be applied to the nodes in the node group when they are created.\n 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. For more information, see Node taints on managed node groups.
The resources associated with the node group, such as Auto Scaling groups and security\n groups for remote access.
" - } - }, - "diskSize": { - "target": "com.amazonaws.eks#BoxedInteger", - "traits": { - "smithy.api#documentation": "If the node group wasn't deployed with a launch template, then this is the disk size\n in the node group configuration. If the node group was deployed with a launch template,\n then this is null.
The health status of the node group. If there are issues with your node group's\n health, they are listed here.
" - } - }, - "updateConfig": { - "target": "com.amazonaws.eks#NodegroupUpdateConfig", - "traits": { - "smithy.api#documentation": "The node group update configuration.
" - } - }, - "launchTemplate": { - "target": "com.amazonaws.eks#LaunchTemplateSpecification", - "traits": { - "smithy.api#documentation": "If a launch template was used to create the node group, then this is the launch\n template that was used.
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an Amazon EKS managed node group.
" - } - }, - "com.amazonaws.eks#NodegroupHealth": { - "type": "structure", - "members": { - "issues": { - "target": "com.amazonaws.eks#IssueList", - "traits": { - "smithy.api#documentation": "Any issues that are associated with the node group.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the health status of the node group.
" - } - }, - "com.amazonaws.eks#NodegroupIssueCode": { - "type": "enum", - "members": { - "AUTO_SCALING_GROUP_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoScalingGroupNotFound" - } - }, - "AUTO_SCALING_GROUP_INVALID_CONFIGURATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoScalingGroupInvalidConfiguration" - } - }, - "EC2_SECURITY_GROUP_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SecurityGroupNotFound" - } - }, - "EC2_SECURITY_GROUP_DELETION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SecurityGroupDeletionFailure" - } - }, - "EC2_LAUNCH_TEMPLATE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2LaunchTemplateNotFound" - } - }, - "EC2_LAUNCH_TEMPLATE_VERSION_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2LaunchTemplateVersionMismatch" - } - }, - "EC2_SUBNET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SubnetNotFound" - } - }, - "EC2_SUBNET_INVALID_CONFIGURATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SubnetInvalidConfiguration" - } - }, - "IAM_INSTANCE_PROFILE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IamInstanceProfileNotFound" - } - }, - "EC2_SUBNET_MISSING_IPV6_ASSIGNMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SubnetMissingIpv6Assignment" - } - }, - "IAM_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IamLimitExceeded" - } - }, - "IAM_NODE_ROLE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IamNodeRoleNotFound" - } - }, - "NODE_CREATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NodeCreationFailure" - } - }, - "ASG_INSTANCE_LAUNCH_FAILURES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AsgInstanceLaunchFailures" - } - }, - "INSTANCE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceLimitExceeded" - } - }, - "INSUFFICIENT_FREE_ADDRESSES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InsufficientFreeAddresses" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessDenied" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalFailure" - } - }, - "CLUSTER_UNREACHABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClusterUnreachable" - } - }, - "AMI_ID_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AmiIdNotFound" - } - }, - "AUTO_SCALING_GROUP_OPT_IN_REQUIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoScalingGroupOptInRequired" - } - }, - "AUTO_SCALING_GROUP_RATE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoScalingGroupRateLimitExceeded" - } - }, - "EC2_LAUNCH_TEMPLATE_DELETION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2LaunchTemplateDeletionFailure" - } - }, - "EC2_LAUNCH_TEMPLATE_INVALID_CONFIGURATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2LaunchTemplateInvalidConfiguration" - } - }, - "EC2_LAUNCH_TEMPLATE_MAX_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2LaunchTemplateMaxLimitExceeded" - } - }, - "EC2_SUBNET_LIST_TOO_LONG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Ec2SubnetListTooLong" - } - }, - "IAM_THROTTLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IamThrottling" - } - }, - "NODE_TERMINATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NodeTerminationFailure" - } - }, - "POD_EVICTION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PodEvictionFailure" - } - }, - "SOURCE_EC2_LAUNCH_TEMPLATE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SourceEc2LaunchTemplateNotFound" - } - }, - "LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LimitExceeded" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - }, - "AUTO_SCALING_GROUP_INSTANCE_REFRESH_ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoScalingGroupInstanceRefreshActive" - } - } - } - }, - "com.amazonaws.eks#NodegroupResources": { - "type": "structure", - "members": { - "autoScalingGroups": { - "target": "com.amazonaws.eks#AutoScalingGroupList", - "traits": { - "smithy.api#documentation": "The Auto Scaling groups associated with the node group.
" - } - }, - "remoteAccessSecurityGroup": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The remote access security group associated with the node group. This security group\n controls SSH access to the nodes.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the resources associated with the node group, such as Auto\n Scaling groups and security groups for remote access.
" - } - }, - "com.amazonaws.eks#NodegroupScalingConfig": { - "type": "structure", - "members": { - "minSize": { - "target": "com.amazonaws.eks#ZeroCapacity", - "traits": { - "smithy.api#documentation": "The minimum number of nodes that the managed node group can scale in to.
" - } - }, - "maxSize": { - "target": "com.amazonaws.eks#Capacity", - "traits": { - "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 the Kubernetes Cluster\n 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.
Whenever 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\n starting with extra hosts for testing. This parameter can also be different when you\n want to start with an estimated number of needed hosts, but let the Cluster Autoscaler\n reduce the number if there are too many. When the Cluster Autoscaler is used, the\n desiredSize parameter is altered by the Cluster Autoscaler (but can be\n out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed\n node group lower than minSize or higher than maxSize.
An object representing the scaling configuration details for the Auto Scaling\n group that is associated with your node group. When creating a node group, you must\n specify all or none of the properties. When updating a node group, you can specify any\n or none of the properties.
" - } - }, - "com.amazonaws.eks#NodegroupStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - }, - "DEGRADED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEGRADED" - } - } - } - }, - "com.amazonaws.eks#NodegroupUpdateConfig": { - "type": "structure", - "members": { - "maxUnavailable": { - "target": "com.amazonaws.eks#NonZeroInteger", - "traits": { - "smithy.api#documentation": "The maximum number of nodes unavailable at once during a version update. Nodes are\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\n of nodes are updated in parallel, up to 100 nodes at once. This value or\n maxUnavailable is required to have a value.
The node group update configuration.
" - } - }, - "com.amazonaws.eks#NonZeroInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.eks#NotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A service resource associated with the request could not be found. Clients should not\n retry such requests.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A service resource associated with the request could not be found. Clients should not\n retry such requests.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.eks#OIDC": { - "type": "structure", - "members": { - "issuer": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The issuer URL for the OIDC identity provider.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the OpenID Connect\n (OIDC) identity provider information for the cluster.
" - } - }, - "com.amazonaws.eks#OidcIdentityProviderConfig": { - "type": "structure", - "members": { - "identityProviderConfigName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the configuration.
" - } - }, - "identityProviderConfigArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the configuration.
" - } - }, - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
" - } - }, - "issuerUrl": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The URL of the OIDC identity provider that allows the API server to discover public\n signing keys for verifying tokens.
" - } - }, - "clientId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "This is also known as audience. The ID of the client application\n that makes authentication requests to the OIDC identity provider.
" - } - }, - "usernameClaim": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The JSON Web token (JWT) claim that is used as the username.
" - } - }, - "usernamePrefix": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The prefix that is prepended to username claims to prevent clashes with existing\n names. The prefix can't contain system:\n
The JSON web token (JWT) claim that the provider uses to return your groups.
" - } - }, - "groupsPrefix": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The prefix that is prepended to group claims to prevent clashes with existing names\n (such as system: groups). For example, the value oidc: creates\n group names like oidc:engineering and oidc:infra. The prefix\n can't contain system:\n
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.
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - }, - "status": { - "target": "com.amazonaws.eks#configStatus", - "traits": { - "smithy.api#documentation": "The status of the OIDC identity provider.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the configuration for an OpenID Connect (OIDC) identity provider.\n
" - } - }, - "com.amazonaws.eks#OidcIdentityProviderConfigRequest": { - "type": "structure", - "members": { - "identityProviderConfigName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the OIDC provider configuration.
", - "smithy.api#required": {} - } - }, - "issuerUrl": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The URL of the OIDC identity provider that allows the API server to discover public\n signing keys for verifying tokens. The URL must begin with https:// and\n should correspond to the iss claim in the provider's OIDC ID tokens.\n Based on the OIDC standard, path components are allowed but query parameters are not.\n Typically the URL consists of only a hostname, like\n https://server.example.org or https://example.com. This\n URL should point to the level below .well-known/openid-configuration and\n must be publicly accessible over the internet.
This is also known as audience. The ID for the client application\n that makes authentication requests to the OIDC identity provider.
", - "smithy.api#required": {} - } - }, - "usernameClaim": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The JSON Web Token (JWT) claim to use as the username. The default is\n sub, which is expected to be a unique identifier of the end user. You can\n choose other claims, such as email or name, depending on the\n OIDC identity provider. Claims other than email are prefixed with the\n issuer URL to prevent naming clashes with other plug-ins.
The prefix that is prepended to username claims to prevent clashes with existing\n names. If you do not provide this field, and username is a value other than\n email, the prefix defaults to issuerurl#. You can use the\n value - to disable all prefixing.
The JWT claim that the provider uses to return your groups.
" - } - }, - "groupsPrefix": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The prefix that is prepended to group claims to prevent clashes with existing names\n (such as system: groups). For example, the value oidc: will\n create group names like oidc:engineering and\n oidc:infra.
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.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an OpenID Connect (OIDC) configuration. Before associating an\n OIDC identity provider to your cluster, review the considerations in Authenticating\n users for your cluster from an OIDC identity provider in the\n Amazon EKS User Guide.
" - } - }, - "com.amazonaws.eks#OutpostConfigRequest": { - "type": "structure", - "members": { - "outpostArns": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The ARN of the Outpost that you want to use for your local Amazon EKS\n cluster on Outposts. Only a single Outpost ARN is supported.
", - "smithy.api#required": {} - } - }, - "controlPlaneInstanceType": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes\n that your cluster will have. For more information, see Capacity\n considerations in the Amazon EKS User Guide.
\nThe instance type that you specify is used for all Kubernetes control plane instances. The\n instance type can't be changed after cluster creation. The control plane is not\n automatically scaled by Amazon EKS.
\n", - "smithy.api#required": {} - } - }, - "controlPlanePlacement": { - "target": "com.amazonaws.eks#ControlPlanePlacementRequest", - "traits": { - "smithy.api#documentation": "
An object representing the placement configuration for all the control plane instances\n of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more\n information, see Capacity considerations in the Amazon EKS User Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration of your local Amazon EKS cluster on an Amazon Web Services\n Outpost. Before creating a cluster on an Outpost, review Creating a local\n cluster on an Outpost in the Amazon EKS User Guide. This API isn't available for\n Amazon EKS clusters on the Amazon Web Services cloud.
" - } - }, - "com.amazonaws.eks#OutpostConfigResponse": { - "type": "structure", - "members": { - "outpostArns": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The ARN of the Outpost that you specified for use with your local Amazon EKS\n cluster on Outposts.
", - "smithy.api#required": {} - } - }, - "controlPlaneInstanceType": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EC2 instance type used for the control plane. The instance type is\n the same for all control plane instances.
", - "smithy.api#required": {} - } - }, - "controlPlanePlacement": { - "target": "com.amazonaws.eks#ControlPlanePlacementResponse", - "traits": { - "smithy.api#documentation": "An object representing the placement configuration for all the control plane instances\n of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more\n information, see Capacity\n considerations in the Amazon EKS User Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the configuration of your local Amazon EKS cluster on\n an Amazon Web Services Outpost. This API isn't available for Amazon EKS clusters\n on the Amazon Web Services cloud.
" - } - }, - "com.amazonaws.eks#PercentCapacity": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.eks#PodIdentityAssociation": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the cluster that the association is in.
" - } - }, - "namespace": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.
" - } - }, - "serviceAccount": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
" - } - }, - "roleArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity\n agent manages credentials to assume this role for applications in the containers in the\n pods that use this service account.
" - } - }, - "associationArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the association.
" - } - }, - "associationId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the association.
" - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
\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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The timestamp that the association was created at.
" - } - }, - "modifiedAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The most recent timestamp that the association was modified at
" - } - } - }, - "traits": { - "smithy.api#documentation": "Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.
" - } - }, - "com.amazonaws.eks#PodIdentityAssociationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#PodIdentityAssociationSummary" - } - }, - "com.amazonaws.eks#PodIdentityAssociationSummary": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the cluster that the association is in.
" - } - }, - "namespace": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes namespace inside the cluster to create the association in. The\n service account and the pods that use the service account must be in this\n namespace.
" - } - }, - "serviceAccount": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.
" - } - }, - "associationArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the association.
" - } - }, - "associationId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the association.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The summarized description of the association.
\nEach summary is simplified by removing these fields compared to the full \n PodIdentityAssociation\n :
The IAM role: roleArn\n
The timestamp that the association was created at: createdAt\n
The most recent timestamp that the association was modified at:. modifiedAt\n
The tags on the association: tags\n
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be\n symmetric and created in the same Amazon Web Services Region as the cluster. If the\n KMS key was created in a different account, the IAM principal must\n have access to the KMS key. For more information, see Allowing\n users in other accounts to use a KMS key in the\n Key Management Service Developer Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Identifies the Key Management Service (KMS) key used to encrypt the\n secrets.
" - } - }, - "com.amazonaws.eks#RegisterCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#RegisterClusterRequest" - }, - "output": { - "target": "com.amazonaws.eks#RegisterClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#AccessDeniedException" - }, - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceLimitExceededException" - }, - { - "target": "com.amazonaws.eks#ResourcePropagationDelayException" - }, - { - "target": "com.amazonaws.eks#ServerException" - }, - { - "target": "com.amazonaws.eks#ServiceUnavailableException" - } - ], - "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\n 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 native\n provider to provide visibility.
After the manifest is updated and applied, the connected cluster is visible to the\n Amazon EKS control plane. If the manifest isn't applied within three days,\n the connected cluster will no longer be visible and must be deregistered using\n DeregisterCluster.
A unique name for this cluster in your Amazon Web Services Region.
", - "smithy.api#required": {} - } - }, - "connectorConfig": { - "target": "com.amazonaws.eks#ConnectorConfigRequest", - "traits": { - "smithy.api#documentation": "The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#RegisterClusterResponse": { - "type": "structure", - "members": { - "cluster": { - "target": "com.amazonaws.eks#Cluster" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#RemoteAccessConfig": { - "type": "structure", - "members": { - "ec2SshKey": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EC2 SSH key name that provides access for SSH communication with\n the 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. For\n Windows, an Amazon EC2 SSH key is used to obtain the RDP password. For more\n information, see Amazon EC2 key pairs and Windows instances in\n the Amazon Elastic Compute Cloud User Guide for Windows Instances.
" - } - }, - "sourceSecurityGroups": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The security group IDs that are allowed SSH access (port 22) to the nodes. For\n Windows, the port is 3389. If you specify an Amazon EC2 SSH key but don't\n specify a source security group when you create a managed node group, then the port on\n the nodes is opened to the internet (0.0.0.0/0). For more information, see\n Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
An object representing the remote access configuration for the managed node\n group.
" - } - }, - "com.amazonaws.eks#ResolveConflicts": { - "type": "enum", - "members": { - "OVERWRITE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OVERWRITE" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "PRESERVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRESERVE" - } - } - } - }, - "com.amazonaws.eks#ResourceInUseException": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The specified add-on name is in use.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS message associated with the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified resource is in use.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.eks#ResourceLimitExceededException": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "subscriptionId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS message associated with the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "You have encountered a service limit on the specified resource.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.eks#ResourceNotFoundException": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "fargateProfileName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Fargate profile associated with the exception.
" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" - } - }, - "subscriptionId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS message associated with the exception.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified resource could not be found. You can view your available clusters with\n ListClusters. You can view your available managed node groups with\n ListNodegroups. Amazon EKS clusters and node groups are Amazon Web Services Region specific.
Required resources (such as service-linked roles) were created and are still\n propagating. Retry later.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Required resources (such as service-linked roles) were created and are still\n propagating. Retry later.
", - "smithy.api#error": "client", - "smithy.api#httpError": 428 - } - }, - "com.amazonaws.eks#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.eks#ServerException": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS add-on name associated with the exception.
" - } - }, - "subscriptionId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS subscription ID with the exception.
" - } - }, - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "These errors are usually caused by a server-side issue.
" - } - } - }, - "traits": { - "smithy.api#documentation": "These errors are usually caused by a server-side issue.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.eks#ServiceUnavailableException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The request has failed due to a temporary failure of the server.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The service is unavailable. Back off and retry the operation.
", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.eks#String": { - "type": "string" - }, - "com.amazonaws.eks#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#String" - } - }, - "com.amazonaws.eks#TagKey": { - "type": "string", - "traits": { - "smithy.api#documentation": "One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.
The metadata that you apply to a resource to help you categorize and organize them.\n Each tag consists of a key and an optional value. You define them.
\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\n 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,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Associates the specified tags to an Amazon EKS resource with the specified\n resourceArn. If existing tags on a resource are not specified in the\n request parameters, they aren't changed. When a resource is deleted, the tags associated\n with that resource are also deleted. Tags that you create for Amazon EKS\n resources don't propagate to any other resources associated with the cluster. For\n example, if you tag a cluster with this operation, that tag doesn't automatically\n propagate to the subnets and nodes associated with the cluster.
The Amazon Resource Name (ARN) of the resource to add tags to.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.eks#TagMap", - "traits": { - "smithy.api#documentation": "Metadata that assists with categorization and organization.\n Each tag consists of a key and an optional value. You define both. Tags don't\n propagate to any other cluster or Amazon Web Services resources.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#TagValue": { - "type": "string", - "traits": { - "smithy.api#documentation": "The optional part of a key-value pair that make up a tag. A value acts as\n a descriptor within a tag category (key).
The key of the taint.
" - } - }, - "value": { - "target": "com.amazonaws.eks#taintValue", - "traits": { - "smithy.api#documentation": "The value of the taint.
" - } - }, - "effect": { - "target": "com.amazonaws.eks#TaintEffect", - "traits": { - "smithy.api#documentation": "The effect of the taint.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A property that allows a node to repel a Pod. For more information, see\n Node taints on\n managed node groups in the Amazon EKS User Guide.
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.
" - } - }, - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS cluster associated with the exception.
" - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon EKS managed node group associated with the exception.
" - } - }, - "validZones": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The supported Availability Zones for your account. Choose subnets in these\n Availability Zones for your cluster.
" - } - } - }, - "traits": { - "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 - } - }, - "com.amazonaws.eks#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.eks#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#BadRequestException" - }, - { - "target": "com.amazonaws.eks#NotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes specified tags from an Amazon EKS resource.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.eks#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to delete tags from.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.eks#TagKeyList", - "traits": { - "smithy.api#documentation": "The keys of the tags to remove.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#Update": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A UUID that is used to track the update.
" - } - }, - "status": { - "target": "com.amazonaws.eks#UpdateStatus", - "traits": { - "smithy.api#documentation": "The current status of the update.
" - } - }, - "type": { - "target": "com.amazonaws.eks#UpdateType", - "traits": { - "smithy.api#documentation": "The type of the update.
" - } - }, - "params": { - "target": "com.amazonaws.eks#UpdateParams", - "traits": { - "smithy.api#documentation": "A key-value map that contains the parameters associated with the update.
" - } - }, - "createdAt": { - "target": "com.amazonaws.eks#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix epoch timestamp at object creation.
" - } - }, - "errors": { - "target": "com.amazonaws.eks#ErrorDetails", - "traits": { - "smithy.api#documentation": "Any errors associated with a Failed update.
An object representing an asynchronous update.
" - } - }, - "com.amazonaws.eks#UpdateAccessConfigRequest": { - "type": "structure", - "members": { - "authenticationMode": { - "target": "com.amazonaws.eks#AuthenticationMode", - "traits": { - "smithy.api#documentation": "The desired authentication mode for the cluster.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The access configuration information for the cluster.
" - } - }, - "com.amazonaws.eks#UpdateAccessEntry": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#UpdateAccessEntryRequest" - }, - "output": { - "target": "com.amazonaws.eks#UpdateAccessEntryResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Updates an access entry.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/access-entries/{principalArn}", - "code": 200 - } - } - }, - "com.amazonaws.eks#UpdateAccessEntryRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "principalArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
The value for name that you've specified for kind: Group as\n a subject in a Kubernetes RoleBinding or\n ClusterRoleBinding object. Amazon EKS doesn't confirm that the\n value for name exists in any bindings on your cluster. You can specify one\n or more names.
Kubernetes authorizes the principalArn of the access entry to access any\n cluster objects that you've specified in a Kubernetes Role or\n ClusterRole object that is also specified in a binding's\n roleRef. For more information about creating Kubernetes\n RoleBinding, ClusterRoleBinding, Role, or\n ClusterRole objects, see Using RBAC\n Authorization in the Kubernetes documentation.
If you want Amazon EKS to authorize the principalArn (instead of,\n or in addition to Kubernetes authorizing the principalArn), you can associate\n one or more access policies to the access entry using\n AssociateAccessPolicy. If you associate any access policies, the\n principalARN has all permissions assigned in the associated access\n policies and all permissions in any Kubernetes Role or ClusterRole\n objects that the group names are bound to.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "username": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The username to authenticate to Kubernetes with. We recommend not specifying a username and\n letting Amazon EKS specify it for you. For more information about the value\n Amazon EKS specifies for you, or constraints before specifying your own\n username, see Creating\n access entries in the Amazon EKS User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UpdateAccessEntryResponse": { - "type": "structure", - "members": { - "accessEntry": { - "target": "com.amazonaws.eks#AccessEntry", - "traits": { - "smithy.api#documentation": "The ARN of the IAM principal for the AccessEntry.
Updates an Amazon EKS add-on.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/addons/{addonName}/update", - "code": 200 - } - } - }, - "com.amazonaws.eks#UpdateAddonRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#ClusterName", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "addonName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the add-on. The name must match one of the names returned by \n ListAddons\n .
The version of the add-on. The version must match one of the versions returned by \n DescribeAddonVersions\n .
The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on's service account. The role must be assigned the IAM permissions required by the add-on. If you don't specify an existing IAM role, then the add-on uses the\n permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.
\nTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for\n your cluster. For more information, see Enabling\n IAM roles for service accounts on your cluster in the\n Amazon EKS User Guide.
\nHow to resolve field value conflicts for an Amazon EKS add-on if you've\n changed a value from the Amazon EKS default value. Conflicts are handled based\n on the option you choose:
\n\n None – Amazon EKS doesn't\n change the value. The update might fail.
\n\n Overwrite – Amazon EKS\n overwrites the changed value back to the Amazon EKS default\n value.
\n\n Preserve – Amazon EKS\n preserves the value. If you choose this option, we recommend that you test any\n field and value changes on a non-production cluster before updating the add-on\n on your production cluster.
\nA unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "configurationValues": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The set of configuration values for the add-on that's created. The values that you\n provide are validated against the schema returned by\n DescribeAddonConfiguration.
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 DescribeUpdate\"/>.
You can use this API operation to enable or disable exporting the Kubernetes control plane\n logs for your cluster to CloudWatch Logs. By default, cluster control plane logs\n 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 also use this API operation to choose different subnets and security groups\n for the cluster. You must specify at least two subnets that are in different\n Availability Zones. You can't change which VPC the subnets are from, the subnets must be\n in the same VPC as the subnets that the cluster was created with. For more information\n about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the \n Amazon EKS User Guide\n .
\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.
The name of the Amazon EKS cluster to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "resourcesVpcConfig": { - "target": "com.amazonaws.eks#VpcConfigRequest" - }, - "logging": { - "target": "com.amazonaws.eks#Logging", - "traits": { - "smithy.api#documentation": "Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see 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.
\nA unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - }, - "accessConfig": { - "target": "com.amazonaws.eks#UpdateAccessConfigRequest", - "traits": { - "smithy.api#documentation": "The access configuration for the cluster.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UpdateClusterConfigResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#UpdateClusterVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#UpdateClusterVersionRequest" - }, - "output": { - "target": "com.amazonaws.eks#UpdateClusterVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster\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 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’ Kubernetes\n versions must match the cluster’s Kubernetes version in order to update the cluster to a new\n Kubernetes version.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{name}/updates", - "code": 200 - } - } - }, - "com.amazonaws.eks#UpdateClusterVersionRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the Amazon EKS cluster to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The desired Kubernetes version following a successful update.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UpdateClusterVersionResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update", - "traits": { - "smithy.api#documentation": "The full description of the specified update
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#UpdateEksAnywhereSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#UpdateEksAnywhereSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.eks#UpdateEksAnywhereSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Update an EKS Anywhere Subscription. Only auto renewal and tags can be updated after\n subscription creation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/eks-anywhere-subscriptions/{id}", - "code": 200 - } - } - }, - "com.amazonaws.eks#UpdateEksAnywhereSubscriptionRequest": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the subscription.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "autoRenew": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A boolean indicating whether or not to automatically renew the subscription.
", - "smithy.api#required": {} - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier to ensure the idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UpdateEksAnywhereSubscriptionResponse": { - "type": "structure", - "members": { - "subscription": { - "target": "com.amazonaws.eks#EksAnywhereSubscription", - "traits": { - "smithy.api#documentation": "The full description of the updated subscription.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#UpdateLabelsPayload": { - "type": "structure", - "members": { - "addOrUpdateLabels": { - "target": "com.amazonaws.eks#labelsMap", - "traits": { - "smithy.api#documentation": "The Kubernetes labels to add or update.
The Kubernetes labels to remove.
An object representing a Kubernetes label change for a managed node\n group.
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 labels\n for a node group or the scaling configuration.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-config", - "code": 200 - } - } - }, - "com.amazonaws.eks#UpdateNodegroupConfigRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the managed node group to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "labels": { - "target": "com.amazonaws.eks#UpdateLabelsPayload", - "traits": { - "smithy.api#documentation": "The Kubernetes labels to apply to the nodes in the node group after the\n update.
The Kubernetes taints to be applied to the nodes in the node group after the update. For\n more information, see Node taints on\n managed node groups.
" - } - }, - "scalingConfig": { - "target": "com.amazonaws.eks#NodegroupScalingConfig", - "traits": { - "smithy.api#documentation": "The scaling configuration details for the Auto Scaling group after the update.
" - } - }, - "updateConfig": { - "target": "com.amazonaws.eks#NodegroupUpdateConfig", - "traits": { - "smithy.api#documentation": "The node group update configuration.
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UpdateNodegroupConfigResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#UpdateNodegroupVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#UpdateNodegroupVersionRequest" - }, - "output": { - "target": "com.amazonaws.eks#UpdateNodegroupVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#ClientException" - }, - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceInUseException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "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 version in\n the request. You can update to the latest AMI version of your cluster's current Kubernetes\n version by specifying your cluster's Kubernetes version in the request. For information about\n Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the\n Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.
\nYou cannot roll back a node group to an earlier Kubernetes version or AMI version.
\nWhen a node in a managed node group is terminated due to a scaling action or update,\n every Pod on that node is drained first. Amazon EKS attempts to\n drain the nodes gracefully and will fail if it is unable to do so. You can\n force the update if Amazon EKS is unable to drain the nodes as\n a result of a Pod disruption budget issue.
The name of your cluster.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodegroupName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the managed node group to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "version": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The Kubernetes version to update to. If no version is specified, then the Kubernetes version of\n the node group does not change. You can specify the Kubernetes version of the cluster to\n update the node group to the latest AMI version of the cluster's Kubernetes version.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify version,\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.
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 used.\n For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the\n Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the\n Amazon EKS User Guide.
\nIf 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.
An object representing a node group's launch template specification. You can only\n update a node group using a launch template if the node group was originally deployed\n with a launch template.
" - } - }, - "force": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Force the update if any Pod on the existing node group can't be drained\n due to a Pod disruption budget issue. If an update fails because all Pods\n can't be drained, you can force the update after it fails to terminate the old node\n whether or not any Pod is running on the node.
A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UpdateNodegroupVersionResponse": { - "type": "structure", - "members": { - "update": { - "target": "com.amazonaws.eks#Update" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#UpdateParam": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.eks#UpdateParamType", - "traits": { - "smithy.api#documentation": "The keys associated with an update request.
" - } - }, - "value": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The value of the keys submitted as part of an update request.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the details of an update request.
" - } - }, - "com.amazonaws.eks#UpdateParamType": { - "type": "enum", - "members": { - "VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Version" - } - }, - "PLATFORM_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PlatformVersion" - } - }, - "ENDPOINT_PRIVATE_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EndpointPrivateAccess" - } - }, - "ENDPOINT_PUBLIC_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EndpointPublicAccess" - } - }, - "CLUSTER_LOGGING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClusterLogging" - } - }, - "DESIRED_SIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DesiredSize" - } - }, - "LABELS_TO_ADD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LabelsToAdd" - } - }, - "LABELS_TO_REMOVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LabelsToRemove" - } - }, - "TAINTS_TO_ADD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TaintsToAdd" - } - }, - "TAINTS_TO_REMOVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TaintsToRemove" - } - }, - "MAX_SIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaxSize" - } - }, - "MIN_SIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MinSize" - } - }, - "RELEASE_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ReleaseVersion" - } - }, - "PUBLIC_ACCESS_CIDRS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PublicAccessCidrs" - } - }, - "LAUNCH_TEMPLATE_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LaunchTemplateName" - } - }, - "LAUNCH_TEMPLATE_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LaunchTemplateVersion" - } - }, - "IDENTITY_PROVIDER_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IdentityProviderConfig" - } - }, - "ENCRYPTION_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EncryptionConfig" - } - }, - "ADDON_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AddonVersion" - } - }, - "SERVICE_ACCOUNT_ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ServiceAccountRoleArn" - } - }, - "RESOLVE_CONFLICTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResolveConflicts" - } - }, - "MAX_UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaxUnavailable" - } - }, - "MAX_UNAVAILABLE_PERCENTAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaxUnavailablePercentage" - } - }, - "CONFIGURATION_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ConfigurationValues" - } - }, - "SECURITY_GROUPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SecurityGroups" - } - }, - "SUBNETS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Subnets" - } - }, - "AUTHENTICATION_MODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AuthenticationMode" - } - } - } - }, - "com.amazonaws.eks#UpdateParams": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#UpdateParam" - } - }, - "com.amazonaws.eks#UpdatePodIdentityAssociation": { - "type": "operation", - "input": { - "target": "com.amazonaws.eks#UpdatePodIdentityAssociationRequest" - }, - "output": { - "target": "com.amazonaws.eks#UpdatePodIdentityAssociationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.eks#InvalidParameterException" - }, - { - "target": "com.amazonaws.eks#InvalidRequestException" - }, - { - "target": "com.amazonaws.eks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.eks#ServerException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a EKS Pod Identity association. Only the IAM role can be changed; an association can't be moved\n between clusters, namespaces, or service accounts. If you need to edit the namespace\n or service account, you need to delete the association and then create a new\n association with your desired settings.
", - "smithy.api#http": { - "method": "POST", - "uri": "/clusters/{clusterName}/pod-identity-associations/{associationId}", - "code": 200 - } - } - }, - "com.amazonaws.eks#UpdatePodIdentityAssociationRequest": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The name of the cluster that you want to update the association in.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "associationId": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The ID of the association to be updated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "roleArn": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The new IAM role to change the
" - } - }, - "clientRequestToken": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure\nthe idempotency of the request.
", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.eks#UpdatePodIdentityAssociationResponse": { - "type": "structure", - "members": { - "association": { - "target": "com.amazonaws.eks#PodIdentityAssociation", - "traits": { - "smithy.api#documentation": "The full description of the EKS Pod Identity association that was updated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.eks#UpdateStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InProgress" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Failed" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - }, - "SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Successful" - } - } - } - }, - "com.amazonaws.eks#UpdateTaintsPayload": { - "type": "structure", - "members": { - "addOrUpdateTaints": { - "target": "com.amazonaws.eks#taintsList", - "traits": { - "smithy.api#documentation": "Kubernetes taints to be added or updated.
" - } - }, - "removeTaints": { - "target": "com.amazonaws.eks#taintsList", - "traits": { - "smithy.api#documentation": "Kubernetes taints to remove.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing the details of an update to a taints payload. For more\n information, see Node taints on\n managed node groups in the Amazon EKS User Guide.
" - } - }, - "com.amazonaws.eks#UpdateType": { - "type": "enum", - "members": { - "VERSION_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VersionUpdate" - } - }, - "ENDPOINT_ACCESS_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EndpointAccessUpdate" - } - }, - "LOGGING_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LoggingUpdate" - } - }, - "CONFIG_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ConfigUpdate" - } - }, - "ASSOCIATE_IDENTITY_PROVIDER_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AssociateIdentityProviderConfig" - } - }, - "DISASSOCIATE_IDENTITY_PROVIDER_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DisassociateIdentityProviderConfig" - } - }, - "ASSOCIATE_ENCRYPTION_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AssociateEncryptionConfig" - } - }, - "ADDON_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AddonUpdate" - } - }, - "VPC_CONFIG_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VpcConfigUpdate" - } - }, - "ACCESS_CONFIG_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessConfigUpdate" - } - } - } - }, - "com.amazonaws.eks#VpcConfigRequest": { - "type": "structure", - "members": { - "subnetIds": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "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\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. 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 Kubernetes\n API server endpoint. If you disable public access, your cluster's Kubernetes API server can\n only receive requests from within the cluster VPC. The default value for this parameter\n is true, which enables public access for your Kubernetes API server. For more\n information, see Amazon EKS cluster endpoint access control in\n the \n Amazon EKS User Guide\n .
Set this value to true to enable private access for your cluster's Kubernetes\n API server endpoint. If you enable private access, Kubernetes API requests from within your\n cluster's VPC use the private VPC endpoint. The default value for this parameter is\n false, which disables private access for your Kubernetes API server. If you\n 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\n 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, make sure that you specify the necessary CIDR blocks for every\n node and Fargate\n Pod in the cluster. For more information, 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\n cluster.
" - } - }, - "com.amazonaws.eks#VpcConfigResponse": { - "type": "structure", - "members": { - "subnetIds": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The subnets associated with your cluster.
" - } - }, - "securityGroupIds": { - "target": "com.amazonaws.eks#StringList", - "traits": { - "smithy.api#documentation": "The security groups associated with the cross-account elastic network interfaces that\n are used to allow communication between your nodes and the Kubernetes control plane.
" - } - }, - "clusterSecurityGroupId": { - "target": "com.amazonaws.eks#String", - "traits": { - "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": { - "target": "com.amazonaws.eks#String", - "traits": { - "smithy.api#documentation": "The VPC associated with your cluster.
" - } - }, - "endpointPublicAccess": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Whether the public API server endpoint is enabled.
" - } - }, - "endpointPrivateAccess": { - "target": "com.amazonaws.eks#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "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 API\n 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.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object representing an Amazon EKS cluster VPC configuration\n response.
" - } - }, - "com.amazonaws.eks#ZeroCapacity": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.eks#configStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - } - } - }, - "com.amazonaws.eks#labelKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - } - } - }, - "com.amazonaws.eks#labelValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - } - } - }, - "com.amazonaws.eks#labelsKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#String" - } - }, - "com.amazonaws.eks#labelsMap": { - "type": "map", - "key": { - "target": "com.amazonaws.eks#labelKey" - }, - "value": { - "target": "com.amazonaws.eks#labelValue" - } - }, - "com.amazonaws.eks#requiredClaimsKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - } - } - }, - "com.amazonaws.eks#requiredClaimsMap": { - "type": "map", - "key": { - "target": "com.amazonaws.eks#requiredClaimsKey" - }, - "value": { - "target": "com.amazonaws.eks#requiredClaimsValue" - } - }, - "com.amazonaws.eks#requiredClaimsValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 253 - } - } - }, - "com.amazonaws.eks#taintKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - } - } - }, - "com.amazonaws.eks#taintValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 63 + "traits": { + "smithy.api#documentation": "An object representing an Amazon EKS cluster VPC configuration\n response.
" + } + }, + "com.amazonaws.eks#ZeroCapacity": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.eks#configStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + } + } + }, + "com.amazonaws.eks#labelKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#labelValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#labelsKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#String" + } + }, + "com.amazonaws.eks#labelsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#labelKey" + }, + "value": { + "target": "com.amazonaws.eks#labelValue" + } + }, + "com.amazonaws.eks#requiredClaimsKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#requiredClaimsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.eks#requiredClaimsKey" + }, + "value": { + "target": "com.amazonaws.eks#requiredClaimsValue" + } + }, + "com.amazonaws.eks#requiredClaimsValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + } + } + }, + "com.amazonaws.eks#taintKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.eks#taintValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 63 + } + } + }, + "com.amazonaws.eks#taintsList": { + "type": "list", + "member": { + "target": "com.amazonaws.eks#Taint" + } } - } - }, - "com.amazonaws.eks#taintsList": { - "type": "list", - "member": { - "target": "com.amazonaws.eks#Taint" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/guardduty.json b/codegen/sdk-codegen/aws-models/guardduty.json index 6b4072c655a85..aeb5a1ab259c6 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.json +++ b/codegen/sdk-codegen/aws-models/guardduty.json @@ -1,14425 +1,14664 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.guardduty#AcceptAdministratorInvitation": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Accepts the invitation to be a member account and get monitored by a GuardDuty\n administrator account that sent the invitation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/administrator", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AdministratorId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The account ID of the GuardDuty administrator account whose invitation you're\n accepting.
", - "smithy.api#jsonName": "administratorId", - "smithy.api#required": {} - } - }, - "InvitationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value that is used to validate the administrator account to the member\n account.
", - "smithy.api#jsonName": "invitationId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#AcceptInvitation": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#AcceptInvitationRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#AcceptInvitationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This operation is deprecated, use AcceptAdministratorInvitation instead" - }, - "smithy.api#documentation": "Accepts the invitation to be monitored by a GuardDuty administrator account.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/master", - "code": 200 - } - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] }, - "com.amazonaws.guardduty#AcceptInvitationRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "MasterId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The account ID of the GuardDuty administrator account whose invitation you're\n accepting.
", - "smithy.api#jsonName": "masterId", - "smithy.api#required": {} - } - }, - "InvitationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The value that is used to validate the administrator account to the member\n account.
", - "smithy.api#jsonName": "invitationId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "This input is deprecated, use AcceptAdministratorInvitationRequest instead" + "shapes": { + "com.amazonaws.guardduty#AcceptAdministratorInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Accepts the invitation to be a member account and get monitored by a GuardDuty\n administrator account that sent the invitation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/administrator", + "code": 200 + } + } }, - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#AcceptInvitationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#deprecated": { - "message": "This output is deprecated, use AcceptAdministratorInvitationResponse instead" - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#AccessControlList": { - "type": "structure", - "members": { - "AllowsPublicReadAccess": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "A value that indicates whether public read access for the bucket is enabled through an\n Access Control List (ACL).
", - "smithy.api#jsonName": "allowsPublicReadAccess" - } - }, - "AllowsPublicWriteAccess": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "A value that indicates whether public write access for the bucket is enabled through an\n Access Control List (ACL).
", - "smithy.api#jsonName": "allowsPublicWriteAccess" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the current access control policies for the bucket.
" - } - }, - "com.amazonaws.guardduty#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error message.
", - "smithy.api#jsonName": "message" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error type.
", - "smithy.api#jsonName": "__type" - } - } - }, - "traits": { - "smithy.api#documentation": "An access denied exception object.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.guardduty#AccessKeyDetails": { - "type": "structure", - "members": { - "AccessKeyId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The access key ID of the user.
", - "smithy.api#jsonName": "accessKeyId" - } - }, - "PrincipalId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The principal ID of the user.
", - "smithy.api#jsonName": "principalId" - } - }, - "UserName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the user.
", - "smithy.api#jsonName": "userName" - } - }, - "UserType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The type of the user.
", - "smithy.api#jsonName": "userType" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the access keys.
" - } - }, - "com.amazonaws.guardduty#AccountDetail": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The member account ID.
", - "smithy.api#jsonName": "accountId", - "smithy.api#required": {} - } - }, - "Email": { - "target": "com.amazonaws.guardduty#Email", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The email address of the member account.
", - "smithy.api#jsonName": "email", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the account.
" - } - }, - "com.amazonaws.guardduty#AccountDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#AccountDetail" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#AccountFreeTrialInfo": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The account identifier of the GuardDuty member account.
", - "smithy.api#jsonName": "accountId" - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourcesFreeTrial", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "Describes the data source enabled for the GuardDuty member account.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#FreeTrialFeatureConfigurationsResults", - "traits": { - "smithy.api#documentation": "A list of features enabled for the GuardDuty account.
", - "smithy.api#jsonName": "features" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides details of the GuardDuty member account that uses a free trial service.
" - } - }, - "com.amazonaws.guardduty#AccountFreeTrialInfos": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#AccountFreeTrialInfo" - } - }, - "com.amazonaws.guardduty#AccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - } - } - }, - "com.amazonaws.guardduty#AccountIds": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#AccountId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#AccountLevelPermissions": { - "type": "structure", - "members": { - "BlockPublicAccess": { - "target": "com.amazonaws.guardduty#BlockPublicAccess", - "traits": { - "smithy.api#documentation": "Describes the S3 Block Public Access settings of the bucket's parent account.
", - "smithy.api#jsonName": "blockPublicAccess" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the account level permissions on the S3 bucket.
" - } - }, - "com.amazonaws.guardduty#Action": { - "type": "structure", - "members": { - "ActionType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The GuardDuty finding activity type.
", - "smithy.api#jsonName": "actionType" - } - }, - "AwsApiCallAction": { - "target": "com.amazonaws.guardduty#AwsApiCallAction", - "traits": { - "smithy.api#documentation": "Information about the AWS_API_CALL action described in this finding.
", - "smithy.api#jsonName": "awsApiCallAction" - } - }, - "DnsRequestAction": { - "target": "com.amazonaws.guardduty#DnsRequestAction", - "traits": { - "smithy.api#documentation": "Information about the DNS_REQUEST action described in this finding.
", - "smithy.api#jsonName": "dnsRequestAction" - } - }, - "NetworkConnectionAction": { - "target": "com.amazonaws.guardduty#NetworkConnectionAction", - "traits": { - "smithy.api#documentation": "Information about the NETWORK_CONNECTION action described in this finding.
", - "smithy.api#jsonName": "networkConnectionAction" - } - }, - "PortProbeAction": { - "target": "com.amazonaws.guardduty#PortProbeAction", - "traits": { - "smithy.api#documentation": "Information about the PORT_PROBE action described in this finding.
", - "smithy.api#jsonName": "portProbeAction" - } - }, - "KubernetesApiCallAction": { - "target": "com.amazonaws.guardduty#KubernetesApiCallAction", - "traits": { - "smithy.api#documentation": "Information about the Kubernetes API call action described in this finding.
", - "smithy.api#jsonName": "kubernetesApiCallAction" - } - }, - "RdsLoginAttemptAction": { - "target": "com.amazonaws.guardduty#RdsLoginAttemptAction", - "traits": { - "smithy.api#documentation": "Information about RDS_LOGIN_ATTEMPT action described in this finding.
Information whether the user has the permission to use a specific Kubernetes API.
", - "smithy.api#jsonName": "kubernetesPermissionCheckedDetails" - } - }, - "KubernetesRoleBindingDetails": { - "target": "com.amazonaws.guardduty#KubernetesRoleBindingDetails", - "traits": { - "smithy.api#documentation": "Information about the role binding that grants the permission defined in a Kubernetes role.
", - "smithy.api#jsonName": "kubernetesRoleBindingDetails" - } - }, - "KubernetesRoleDetails": { - "target": "com.amazonaws.guardduty#KubernetesRoleDetails", - "traits": { - "smithy.api#documentation": "Information about the Kubernetes role name and role type.
", - "smithy.api#jsonName": "kubernetesRoleDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about actions.
" - } - }, - "com.amazonaws.guardduty#AddonDetails": { - "type": "structure", - "members": { - "AddonVersion": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Version of the installed EKS add-on.
", - "smithy.api#jsonName": "addonVersion" - } - }, - "AddonStatus": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Status of the installed EKS add-on.
", - "smithy.api#jsonName": "addonStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the installed EKS add-on (GuardDuty security agent).
" - } - }, - "com.amazonaws.guardduty#AdminAccount": { - "type": "structure", - "members": { - "AdminAccountId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID for the account.
", - "smithy.api#jsonName": "adminAccountId" - } - }, - "AdminStatus": { - "target": "com.amazonaws.guardduty#AdminStatus", - "traits": { - "smithy.api#documentation": "Indicates whether the account is enabled as the delegated administrator.
", - "smithy.api#jsonName": "adminStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "The account within the organization specified as the GuardDuty delegated\n administrator.
" - } - }, - "com.amazonaws.guardduty#AdminAccounts": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#AdminAccount" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.guardduty#AdminStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLE_IN_PROGRESS" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#Administrator": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "The ID of the account used as the administrator account.
", - "smithy.api#jsonName": "accountId" - } - }, - "InvitationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The value that is used to validate the administrator account to the member\n account.
", - "smithy.api#jsonName": "invitationId" - } - }, - "RelationshipStatus": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The status of the relationship between the administrator and member accounts.
", - "smithy.api#jsonName": "relationshipStatus" - } - }, - "InvitedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The timestamp when the invitation was sent.
", - "smithy.api#jsonName": "invitedAt" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the administrator account and invitation.
" - } - }, - "com.amazonaws.guardduty#AffectedResources": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#String" - }, - "value": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#AgentDetails": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Version of the installed GuardDuty security agent.
", - "smithy.api#jsonName": "version" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the installed GuardDuty security agent.
" - } - }, - "com.amazonaws.guardduty#Anomaly": { - "type": "structure", - "members": { - "Profiles": { - "target": "com.amazonaws.guardduty#AnomalyProfiles", - "traits": { - "smithy.api#documentation": "Information about the types of profiles.
", - "smithy.api#jsonName": "profiles" - } - }, - "Unusual": { - "target": "com.amazonaws.guardduty#AnomalyUnusual", - "traits": { - "smithy.api#documentation": "Information about the behavior of the anomalies.
", - "smithy.api#jsonName": "unusual" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the anomalies.
" - } - }, - "com.amazonaws.guardduty#AnomalyObject": { - "type": "structure", - "members": { - "ProfileType": { - "target": "com.amazonaws.guardduty#ProfileType", - "traits": { - "smithy.api#documentation": "The type of behavior of the profile.
", - "smithy.api#jsonName": "profileType" - } - }, - "ProfileSubtype": { - "target": "com.amazonaws.guardduty#ProfileSubtype", - "traits": { - "smithy.api#documentation": "The frequency of the anomaly.
", - "smithy.api#jsonName": "profileSubtype" - } - }, - "Observations": { - "target": "com.amazonaws.guardduty#Observations", - "traits": { - "smithy.api#documentation": "The recorded value.
", - "smithy.api#jsonName": "observations" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the unusual anomalies.
" - } - }, - "com.amazonaws.guardduty#AnomalyProfileFeatureObjects": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#AnomalyObject" - } - }, - "com.amazonaws.guardduty#AnomalyProfileFeatures": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#String" - }, - "value": { - "target": "com.amazonaws.guardduty#AnomalyProfileFeatureObjects" - } - }, - "com.amazonaws.guardduty#AnomalyProfiles": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#String" - }, - "value": { - "target": "com.amazonaws.guardduty#AnomalyProfileFeatures" - } - }, - "com.amazonaws.guardduty#AnomalyUnusual": { - "type": "structure", - "members": { - "Behavior": { - "target": "com.amazonaws.guardduty#Behavior", - "traits": { - "smithy.api#documentation": "The behavior of the anomalous activity that caused GuardDuty to \n generate the finding.
", - "smithy.api#jsonName": "behavior" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the behavior of the anomaly that is new to GuardDuty.
" - } - }, - "com.amazonaws.guardduty#AnomalyUnusualBehaviorFeature": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#String" - }, - "value": { - "target": "com.amazonaws.guardduty#AnomalyObject" - } - }, - "com.amazonaws.guardduty#ArchiveFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ArchiveFindingsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ArchiveFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Archives GuardDuty findings that are specified by the list of finding IDs.
\nOnly the administrator account can archive findings. Member accounts don't have\n permission to archive findings from their accounts.
\nThe ID of the detector that specifies the GuardDuty service whose findings you want to\n archive.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FindingIds": { - "target": "com.amazonaws.guardduty#FindingIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the findings that you want to archive.
", - "smithy.api#jsonName": "findingIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ArchiveFindingsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#AutoEnableMembers": { - "type": "enum", - "members": { - "NEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.guardduty#AwsApiCallAction": { - "type": "structure", - "members": { - "Api": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services API name.
", - "smithy.api#jsonName": "api" - } - }, - "CallerType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services API caller type.
", - "smithy.api#jsonName": "callerType" - } - }, - "DomainDetails": { - "target": "com.amazonaws.guardduty#DomainDetails", - "traits": { - "smithy.api#documentation": "The domain information for the Amazon Web Services API call.
", - "smithy.api#jsonName": "domainDetails" - } - }, - "ErrorCode": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error code of the failed Amazon Web Services API action.
", - "smithy.api#jsonName": "errorCode" - } - }, - "UserAgent": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The agent through which the API request was made.
", - "smithy.api#jsonName": "userAgent" - } - }, - "RemoteIpDetails": { - "target": "com.amazonaws.guardduty#RemoteIpDetails", - "traits": { - "smithy.api#documentation": "The remote IP information of the connection that initiated the Amazon Web Services API call.
", - "smithy.api#jsonName": "remoteIpDetails" - } - }, - "ServiceName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services service name whose API was invoked.
", - "smithy.api#jsonName": "serviceName" - } - }, - "RemoteAccountDetails": { - "target": "com.amazonaws.guardduty#RemoteAccountDetails", - "traits": { - "smithy.api#documentation": "The details of the Amazon Web Services account that made the API call. This field appears if the call\n was made from outside your account.
", - "smithy.api#jsonName": "remoteAccountDetails" - } - }, - "AffectedResources": { - "target": "com.amazonaws.guardduty#AffectedResources", - "traits": { - "smithy.api#documentation": "The details of the Amazon Web Services account that made the API call. This field identifies the\n resources that were affected by this API call.
", - "smithy.api#jsonName": "affectedResources" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the API action.
" - } - }, - "com.amazonaws.guardduty#BadRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error message.
", - "smithy.api#jsonName": "message" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error type.
", - "smithy.api#jsonName": "__type" - } - } - }, - "traits": { - "smithy.api#documentation": "A bad request exception object.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.guardduty#Behavior": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#String" - }, - "value": { - "target": "com.amazonaws.guardduty#AnomalyUnusualBehaviorFeature" - } - }, - "com.amazonaws.guardduty#BlockPublicAccess": { - "type": "structure", - "members": { - "IgnorePublicAcls": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Indicates if S3 Block Public Access is set to IgnorePublicAcls.
Indicates if S3 Block Public Access is set to RestrictPublicBuckets.
Indicates if S3 Block Public Access is set to BlockPublicAcls.
Indicates if S3 Block Public Access is set to BlockPublicPolicy.
Contains information on how the bucker owner's S3 Block Public Access settings are being\n applied to the S3 bucket. See S3 Block Public\n Access for more information.
" - } - }, - "com.amazonaws.guardduty#Boolean": { - "type": "boolean" - }, - "com.amazonaws.guardduty#BucketLevelPermissions": { - "type": "structure", - "members": { - "AccessControlList": { - "target": "com.amazonaws.guardduty#AccessControlList", - "traits": { - "smithy.api#documentation": "Contains information on how Access Control Policies are applied to the bucket.
", - "smithy.api#jsonName": "accessControlList" - } - }, - "BucketPolicy": { - "target": "com.amazonaws.guardduty#BucketPolicy", - "traits": { - "smithy.api#documentation": "Contains information on the bucket policies for the S3 bucket.
", - "smithy.api#jsonName": "bucketPolicy" - } - }, - "BlockPublicAccess": { - "target": "com.amazonaws.guardduty#BlockPublicAccess", - "traits": { - "smithy.api#documentation": "Contains information on which account level S3 Block Public Access settings are applied to\n the S3 bucket.
", - "smithy.api#jsonName": "blockPublicAccess" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the bucket level permissions for the S3 bucket.
" - } - }, - "com.amazonaws.guardduty#BucketPolicy": { - "type": "structure", - "members": { - "AllowsPublicReadAccess": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "A value that indicates whether public read access for the bucket is enabled through a\n bucket policy.
", - "smithy.api#jsonName": "allowsPublicReadAccess" - } - }, - "AllowsPublicWriteAccess": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "A value that indicates whether public write access for the bucket is enabled through a\n bucket policy.
", - "smithy.api#jsonName": "allowsPublicWriteAccess" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the current bucket policies for the S3 bucket.
" - } - }, - "com.amazonaws.guardduty#City": { - "type": "structure", - "members": { - "CityName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The city name of the remote IP address.
", - "smithy.api#jsonName": "cityName" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the city associated with the IP address.
" - } - }, - "com.amazonaws.guardduty#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.guardduty#CloudTrailConfigurationResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.guardduty#DataSourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes whether CloudTrail is enabled as a data source for the detector.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the status of CloudTrail as a data source for the detector.
" - } - }, - "com.amazonaws.guardduty#Condition": { - "type": "structure", - "members": { - "Eq": { - "target": "com.amazonaws.guardduty#Eq", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Represents the equal condition to be applied to a single field when\n querying for findings.
", - "smithy.api#jsonName": "eq" - } - }, - "Neq": { - "target": "com.amazonaws.guardduty#Neq", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Represents the not equal condition to be applied to a single field\n when querying for findings.
", - "smithy.api#jsonName": "neq" - } - }, - "Gt": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Represents a greater than condition to be applied to a single field\n when querying for findings.
", - "smithy.api#jsonName": "gt" - } - }, - "Gte": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Represents a greater than or equal condition to be applied to a\n single field when querying for findings.
", - "smithy.api#jsonName": "gte" - } - }, - "Lt": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Represents a less than condition to be applied to a single field when\n querying for findings.
", - "smithy.api#jsonName": "lt" - } - }, - "Lte": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Represents a less than or equal condition to be applied to a single\n field when querying for findings.
", - "smithy.api#jsonName": "lte" - } - }, - "Equals": { - "target": "com.amazonaws.guardduty#Equals", - "traits": { - "smithy.api#documentation": "Represents an equal\n condition to be applied to\n a single field when querying for findings.
", - "smithy.api#jsonName": "equals" - } - }, - "NotEquals": { - "target": "com.amazonaws.guardduty#NotEquals", - "traits": { - "smithy.api#documentation": "Represents a not equal\n condition to be applied\n to a single field when querying for findings.
", - "smithy.api#jsonName": "notEquals" - } - }, - "GreaterThan": { - "target": "com.amazonaws.guardduty#Long", - "traits": { - "smithy.api#documentation": "Represents a greater than condition to be applied to a single field\n when querying for findings.
", - "smithy.api#jsonName": "greaterThan" - } - }, - "GreaterThanOrEqual": { - "target": "com.amazonaws.guardduty#Long", - "traits": { - "smithy.api#documentation": "Represents a greater than or equal condition to be applied to a\n single field when querying for findings.
", - "smithy.api#jsonName": "greaterThanOrEqual" - } - }, - "LessThan": { - "target": "com.amazonaws.guardduty#Long", - "traits": { - "smithy.api#documentation": "Represents a less than condition to be applied to a single field when\n querying for findings.
", - "smithy.api#jsonName": "lessThan" - } - }, - "LessThanOrEqual": { - "target": "com.amazonaws.guardduty#Long", - "traits": { - "smithy.api#documentation": "Represents a less than or equal condition to be applied to a single\n field when querying for findings.
", - "smithy.api#jsonName": "lessThanOrEqual" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the condition.
" - } - }, - "com.amazonaws.guardduty#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error message.
", - "smithy.api#jsonName": "message" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error type.
", - "smithy.api#jsonName": "__type" - } - } - }, - "traits": { - "smithy.api#documentation": "A request conflict exception object.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.guardduty#Container": { - "type": "structure", - "members": { - "ContainerRuntime": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The container runtime (such as, Docker or containerd) used to run the container.
", - "smithy.api#jsonName": "containerRuntime" - } - }, - "Id": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Container ID.
", - "smithy.api#jsonName": "id" - } - }, - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Container name.
", - "smithy.api#jsonName": "name" - } - }, - "Image": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Container image.
", - "smithy.api#jsonName": "image" - } - }, - "ImagePrefix": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Part of the image name before the last slash. For example, imagePrefix for\n public.ecr.aws/amazonlinux/amazonlinux:latest would be public.ecr.aws/amazonlinux. If the\n image name is relative and does not have a slash, this field is empty.
", - "smithy.api#jsonName": "imagePrefix" - } - }, - "VolumeMounts": { - "target": "com.amazonaws.guardduty#VolumeMounts", - "traits": { - "smithy.api#documentation": "Container volume mounts.
", - "smithy.api#jsonName": "volumeMounts" - } - }, - "SecurityContext": { - "target": "com.amazonaws.guardduty#SecurityContext", - "traits": { - "smithy.api#documentation": "Container security context.
", - "smithy.api#jsonName": "securityContext" - } - } - }, - "traits": { - "smithy.api#documentation": "Details of a container.
" - } - }, - "com.amazonaws.guardduty#ContainerInstanceDetails": { - "type": "structure", - "members": { - "CoveredContainerInstances": { - "target": "com.amazonaws.guardduty#Long", - "traits": { - "smithy.api#documentation": "Represents the nodes in the Amazon ECS cluster that has a HEALTHY\n coverage status.
Represents total number of nodes in the Amazon ECS cluster.
", - "smithy.api#jsonName": "compatibleContainerInstances" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the Amazon EC2 instance that is running \n the Amazon ECS container.
" - } - }, - "com.amazonaws.guardduty#Containers": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Container" - } - }, - "com.amazonaws.guardduty#CountByCoverageStatus": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#CoverageStatus" - }, - "value": { - "target": "com.amazonaws.guardduty#Long" - } - }, - "com.amazonaws.guardduty#CountByResourceType": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#ResourceType" - }, - "value": { - "target": "com.amazonaws.guardduty#Long" - } - }, - "com.amazonaws.guardduty#CountBySeverity": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#String" - }, - "value": { - "target": "com.amazonaws.guardduty#Integer" - } - }, - "com.amazonaws.guardduty#Country": { - "type": "structure", - "members": { - "CountryCode": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The country code of the remote IP address.
", - "smithy.api#jsonName": "countryCode" - } - }, - "CountryName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The country name of the remote IP address.
", - "smithy.api#jsonName": "countryName" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the country where the remote IP address is located.
" - } - }, - "com.amazonaws.guardduty#CoverageEc2InstanceDetails": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon EC2 instance ID.
", - "smithy.api#jsonName": "instanceId" - } - }, - "InstanceType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The instance type of the Amazon EC2 instance.
", - "smithy.api#jsonName": "instanceType" - } - }, - "ClusterArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The cluster ARN of the Amazon ECS cluster running on \n the Amazon EC2 instance.
", - "smithy.api#jsonName": "clusterArn" - } - }, - "AgentDetails": { - "target": "com.amazonaws.guardduty#AgentDetails", - "traits": { - "smithy.api#documentation": "Information about the installed security agent.
", - "smithy.api#jsonName": "agentDetails" - } - }, - "ManagementType": { - "target": "com.amazonaws.guardduty#ManagementType", - "traits": { - "smithy.api#documentation": "Indicates how the GuardDuty security agent is managed for this resource.
\n\n AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this resource.
\n MANUAL indicates that you are responsible to deploy, update, and manage the GuardDuty \n security agent updates for this resource.
The DISABLED status doesn't apply to Amazon \n EC2 instances and Amazon EKS clusters that run on Amazon EC2 instances.
This API is also used when you use GuardDuty Runtime Monitoring \n for your Amazon EC2 instances (currently in preview\n release) and is subject to change.
\nContains information about the Amazon EC2 instance runtime \n coverage details.
" - } - }, - "com.amazonaws.guardduty#CoverageEcsClusterDetails": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the Amazon ECS cluster.
", - "smithy.api#jsonName": "clusterName" - } - }, - "FargateDetails": { - "target": "com.amazonaws.guardduty#FargateDetails", - "traits": { - "smithy.api#documentation": "Information about the Fargate details associated with the Amazon \n ECS cluster.
", - "smithy.api#jsonName": "fargateDetails" - } - }, - "ContainerInstanceDetails": { - "target": "com.amazonaws.guardduty#ContainerInstanceDetails", - "traits": { - "smithy.api#documentation": "Information about the Amazon ECS container running on Amazon EC2 \n instance.
", - "smithy.api#jsonName": "containerInstanceDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about Amazon ECS cluster runtime coverage details.
" - } - }, - "com.amazonaws.guardduty#CoverageEksClusterDetails": { - "type": "structure", - "members": { - "ClusterName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Name of the EKS cluster.
", - "smithy.api#jsonName": "clusterName" - } - }, - "CoveredNodes": { - "target": "com.amazonaws.guardduty#Long", - "traits": { - "smithy.api#documentation": "Represents the nodes within the EKS cluster that have a HEALTHY coverage\n status.
Represents all the nodes within the EKS cluster in your account.
", - "smithy.api#jsonName": "compatibleNodes" - } - }, - "AddonDetails": { - "target": "com.amazonaws.guardduty#AddonDetails", - "traits": { - "smithy.api#documentation": "Information about the installed EKS add-on.
", - "smithy.api#jsonName": "addonDetails" - } - }, - "ManagementType": { - "target": "com.amazonaws.guardduty#ManagementType", - "traits": { - "smithy.api#documentation": "Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS cluster.
\n\n AUTO_MANAGED indicates GuardDuty deploys and manages updates for this resource.
\n MANUAL indicates that you are responsible to deploy, update, and manage \n the Amazon EKS add-on GuardDuty agent for this resource.
Information about the EKS cluster that has a coverage status.
" - } - }, - "com.amazonaws.guardduty#CoverageFilterCondition": { - "type": "structure", - "members": { - "Equals": { - "target": "com.amazonaws.guardduty#Equals", - "traits": { - "smithy.api#documentation": "Represents an equal condition that is applied to a single field while retrieving the\n coverage details.
", - "smithy.api#jsonName": "equals" - } - }, - "NotEquals": { - "target": "com.amazonaws.guardduty#NotEquals", - "traits": { - "smithy.api#documentation": "Represents a not equal condition that is applied to a single field while retrieving the\n coverage details.
", - "smithy.api#jsonName": "notEquals" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
" - } - }, - "com.amazonaws.guardduty#CoverageFilterCriteria": { - "type": "structure", - "members": { - "FilterCriterion": { - "target": "com.amazonaws.guardduty#CoverageFilterCriterionList", - "traits": { - "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
", - "smithy.api#jsonName": "filterCriterion" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the criteria used in the filter.
" - } - }, - "com.amazonaws.guardduty#CoverageFilterCriterion": { - "type": "structure", - "members": { - "CriterionKey": { - "target": "com.amazonaws.guardduty#CoverageFilterCriterionKey", - "traits": { - "smithy.api#documentation": "An enum value representing possible filter fields.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
Contains information about the condition.
", - "smithy.api#jsonName": "filterCondition" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
" - } - }, - "com.amazonaws.guardduty#CoverageFilterCriterionKey": { - "type": "enum", - "members": { - "ACCOUNT_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_ID" - } - }, - "CLUSTER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER_NAME" - } - }, - "RESOURCE_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_TYPE" - } - }, - "COVERAGE_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COVERAGE_STATUS" - } - }, - "ADDON_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADDON_VERSION" - } - }, - "MANAGEMENT_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANAGEMENT_TYPE" - } - }, - "EKS_CLUSTER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_CLUSTER_NAME" - } - }, - "ECS_CLUSTER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECS_CLUSTER_NAME" - } - }, - "AGENT_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AGENT_VERSION" - } - }, - "INSTANCE_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANCE_ID" - } - }, - "CLUSTER_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER_ARN" - } - } - } - }, - "com.amazonaws.guardduty#CoverageFilterCriterionList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#CoverageFilterCriterion" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#CoverageResource": { - "type": "structure", - "members": { - "ResourceId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID of the resource.
", - "smithy.api#jsonName": "resourceId" - } - }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the GuardDuty detector associated with the resource.
", - "smithy.api#jsonName": "detectorId" - } - }, - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "The unique ID of the Amazon Web Services account.
", - "smithy.api#jsonName": "accountId" - } - }, - "ResourceDetails": { - "target": "com.amazonaws.guardduty#CoverageResourceDetails", - "traits": { - "smithy.api#documentation": "Information about the resource for which the coverage statistics are retrieved.
", - "smithy.api#jsonName": "resourceDetails" - } - }, - "CoverageStatus": { - "target": "com.amazonaws.guardduty#CoverageStatus", - "traits": { - "smithy.api#documentation": "Represents the status of the EKS cluster coverage.
", - "smithy.api#jsonName": "coverageStatus" - } - }, - "Issue": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Represents the reason why a coverage status was UNHEALTHY for the EKS\n cluster.
The timestamp at which the coverage details for the resource were last updated. This is in\n UTC format.
", - "smithy.api#jsonName": "updatedAt" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the resource of the GuardDuty account.
" - } - }, - "com.amazonaws.guardduty#CoverageResourceDetails": { - "type": "structure", - "members": { - "EksClusterDetails": { - "target": "com.amazonaws.guardduty#CoverageEksClusterDetails", - "traits": { - "smithy.api#documentation": "EKS cluster details involved in the coverage statistics.
", - "smithy.api#jsonName": "eksClusterDetails" - } - }, - "ResourceType": { - "target": "com.amazonaws.guardduty#ResourceType", - "traits": { - "smithy.api#documentation": "The type of Amazon Web Services resource.
", - "smithy.api#jsonName": "resourceType" - } - }, - "EcsClusterDetails": { - "target": "com.amazonaws.guardduty#CoverageEcsClusterDetails", - "traits": { - "smithy.api#documentation": "Information about the Amazon ECS cluster that is assessed for \n runtime coverage.
", - "smithy.api#jsonName": "ecsClusterDetails" - } - }, - "Ec2InstanceDetails": { - "target": "com.amazonaws.guardduty#CoverageEc2InstanceDetails", - "traits": { - "smithy.api#documentation": "This API is also used when you use GuardDuty Runtime Monitoring \n for your Amazon EC2 instances (currently in preview\n release) and is subject to change.
\nInformation about the Amazon EC2 instance assessed \n for runtime coverage.
", - "smithy.api#jsonName": "ec2InstanceDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the resource for each individual EKS cluster.
" - } - }, - "com.amazonaws.guardduty#CoverageResources": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#CoverageResource" - } - }, - "com.amazonaws.guardduty#CoverageSortCriteria": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.guardduty#CoverageSortKey", - "traits": { - "smithy.api#documentation": "Represents the field name used to sort the coverage details.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
The order in which the sorted findings are to be displayed.
", - "smithy.api#jsonName": "orderBy" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the sorting criteria used in the coverage statistics.
" - } - }, - "com.amazonaws.guardduty#CoverageSortKey": { - "type": "enum", - "members": { - "ACCOUNT_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_ID" - } - }, - "CLUSTER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER_NAME" - } - }, - "COVERAGE_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COVERAGE_STATUS" - } - }, - "ISSUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ISSUE" - } - }, - "ADDON_VERSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADDON_VERSION" - } - }, - "UPDATED_AT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED_AT" - } - }, - "EKS_CLUSTER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_CLUSTER_NAME" - } - }, - "ECS_CLUSTER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECS_CLUSTER_NAME" - } - }, - "INSTANCE_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANCE_ID" - } - } - } - }, - "com.amazonaws.guardduty#CoverageStatistics": { - "type": "structure", - "members": { - "CountByResourceType": { - "target": "com.amazonaws.guardduty#CountByResourceType", - "traits": { - "smithy.api#documentation": "Represents coverage statistics for EKS clusters aggregated by resource type.
", - "smithy.api#jsonName": "countByResourceType" - } - }, - "CountByCoverageStatus": { - "target": "com.amazonaws.guardduty#CountByCoverageStatus", - "traits": { - "smithy.api#documentation": "Represents coverage statistics for EKS clusters aggregated by coverage status.
", - "smithy.api#jsonName": "countByCoverageStatus" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the coverage statistics for a resource.
" - } - }, - "com.amazonaws.guardduty#CoverageStatisticsType": { - "type": "enum", - "members": { - "COUNT_BY_RESOURCE_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT_BY_RESOURCE_TYPE" - } - }, - "COUNT_BY_COVERAGE_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT_BY_COVERAGE_STATUS" - } - } - } - }, - "com.amazonaws.guardduty#CoverageStatisticsTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#CoverageStatisticsType" - } - }, - "com.amazonaws.guardduty#CoverageStatus": { - "type": "enum", - "members": { - "HEALTHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEALTHY" - } - }, - "UNHEALTHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNHEALTHY" - } - } - } - }, - "com.amazonaws.guardduty#CreateDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#CreateDetectorRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#CreateDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a single Amazon GuardDuty detector. A detector is a resource that represents the\n GuardDuty service. To start using GuardDuty, you must create a detector in each Region where\n you enable the service. You can have only one detector per account per Region. All data\n sources are enabled in a new detector by default.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#CreateDetectorRequest": { - "type": "structure", - "members": { - "Enable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Boolean value that specifies whether the detector is to be enabled.
", - "smithy.api#jsonName": "enable", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.guardduty#ClientToken", - "traits": { - "smithy.api#documentation": "The idempotency token for the create request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" - } - }, - "FindingPublishingFrequency": { - "target": "com.amazonaws.guardduty#FindingPublishingFrequency", - "traits": { - "smithy.api#documentation": "A value that specifies how frequently updated findings are exported.
", - "smithy.api#jsonName": "findingPublishingFrequency" - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurations", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "Describes which data sources will be enabled for the detector.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags to be added to a new detector resource.
", - "smithy.api#jsonName": "tags" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#DetectorFeatureConfigurations", - "traits": { - "smithy.api#documentation": "A list of features that will be configured for the detector.
", - "smithy.api#jsonName": "features" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#CreateDetectorResponse": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the created detector.
", - "smithy.api#jsonName": "detectorId" - } - }, - "UnprocessedDataSources": { - "target": "com.amazonaws.guardduty#UnprocessedDataSourcesResult", - "traits": { - "smithy.api#documentation": "Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the\n first time.
", - "smithy.api#jsonName": "unprocessedDataSources" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#CreateFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#CreateFilterRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#CreateFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a filter using the specified finding criteria. The maximum number of saved filters\n per Amazon Web Services account per Region is 100. For more information, see Quotas for GuardDuty.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/filter", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#CreateFilterRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector belonging to the GuardDuty account that you want to create a filter\n for.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.guardduty#FilterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the filter. Valid characters include period (.), underscore (_), dash (-), and\n alphanumeric characters. A whitespace is considered to be an invalid character.
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.guardduty#FilterDescription", - "traits": { - "smithy.api#documentation": "The description of the filter. Valid characters include alphanumeric characters, and\n special characters such as hyphen, period, colon, underscore, parentheses ({ },\n [ ], and ( )), forward slash, horizontal tab, vertical tab,\n newline, form feed, return, and whitespace.
Specifies the action that is to be applied to the findings that match the filter.
", - "smithy.api#jsonName": "action" - } - }, - "Rank": { - "target": "com.amazonaws.guardduty#FilterRank", - "traits": { - "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.
", - "smithy.api#jsonName": "rank" - } - }, - "FindingCriteria": { - "target": "com.amazonaws.guardduty#FindingCriteria", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]\n
\n Medium: [\"4\", \"5\", \"6\"]\n
\n High: [\"7\", \"8\", \"9\"]\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.namespace
\nservice.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.kubernetesApiCallAction.statusCode
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nThe idempotency token for the create request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags to be added to a new filter resource.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#CreateFilterResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#FilterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the successfully created filter.
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#CreateIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#CreateIPSetRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#CreateIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new IPSet, which is called a trusted IP list in the console user interface. An\n IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services\n infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are\n included in IPSets. Only users from the administrator account can use this operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/ipset", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#CreateIPSetRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to create an IPSet\n for.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.guardduty#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user-friendly name to identify the IPSet.
\nAllowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.guardduty#IpSetFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The format of the file that contains the IPSet.
", - "smithy.api#jsonName": "format", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the file that contains the IPSet.
", - "smithy.api#jsonName": "location", - "smithy.api#required": {} - } - }, - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Boolean value that indicates whether GuardDuty is to start using the uploaded\n IPSet.
", - "smithy.api#jsonName": "activate", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.guardduty#ClientToken", - "traits": { - "smithy.api#documentation": "The idempotency token for the create request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags to be added to a new IP set resource.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#CreateIPSetResponse": { - "type": "structure", - "members": { - "IpSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the IPSet resource.
", - "smithy.api#jsonName": "ipSetId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#CreateMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#CreateMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#CreateMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nAs a delegated administrator, using CreateMembers will enable GuardDuty in \n the added member accounts, with the exception of the\n organization delegated administrator account. A delegated administrator must enable GuardDuty \n prior to being added as a member.
If you are adding accounts by invitation, before using InviteMembers, use \n CreateMembers after GuardDuty has been enabled in potential member accounts.
If you disassociate a member from a GuardDuty \n delegated administrator, the member account details \n obtained from this API, including the associated email addresses, will be retained. \n This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/member", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#CreateMembersRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to associate member\n accounts with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountDetails": { - "target": "com.amazonaws.guardduty#AccountDetails", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account ID and email address pairs of the accounts that you want to associate\n with the GuardDuty administrator account.
", - "smithy.api#jsonName": "accountDetails", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#CreateMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that include the accountIds of the unprocessed accounts and\n a result string that explains why each was unprocessed.
Creates a publishing destination to export findings to. The resource to export findings to\n must exist before you use this operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/publishingDestination", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#CreatePublishingDestinationRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the GuardDuty detector associated with the publishing destination.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "DestinationType": { - "target": "com.amazonaws.guardduty#DestinationType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of resource for the publishing destination. Currently only Amazon S3 buckets are\n supported.
", - "smithy.api#jsonName": "destinationType", - "smithy.api#required": {} - } - }, - "DestinationProperties": { - "target": "com.amazonaws.guardduty#DestinationProperties", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The properties of the publishing destination, including the ARNs for the destination and\n the KMS key used for encryption.
", - "smithy.api#jsonName": "destinationProperties", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.guardduty#ClientToken", - "traits": { - "smithy.api#documentation": "The idempotency token for the request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#CreatePublishingDestinationResponse": { - "type": "structure", - "members": { - "DestinationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the publishing destination that is created.
", - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#CreateSampleFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#CreateSampleFindingsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#CreateSampleFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Generates sample findings of types specified by the list of finding types. If 'NULL' is\n specified for findingTypes, the API generates sample findings of all supported\n finding types.
The ID of the detector to create sample findings for.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FindingTypes": { - "target": "com.amazonaws.guardduty#FindingTypes", - "traits": { - "smithy.api#documentation": "The types of sample findings to generate.
", - "smithy.api#jsonName": "findingTypes" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#CreateSampleFindingsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#CreateThreatIntelSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#CreateThreatIntelSetRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#CreateThreatIntelSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses.\n GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator\n account can use this operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/threatintelset", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#CreateThreatIntelSetRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to create a\n threatIntelSet for.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.guardduty#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.guardduty#ThreatIntelSetFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The format of the file that contains the ThreatIntelSet.
", - "smithy.api#jsonName": "format", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the file that contains the ThreatIntelSet.
", - "smithy.api#jsonName": "location", - "smithy.api#required": {} - } - }, - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A Boolean value that indicates whether GuardDuty is to start using the uploaded\n ThreatIntelSet.
", - "smithy.api#jsonName": "activate", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.guardduty#ClientToken", - "traits": { - "smithy.api#documentation": "The idempotency token for the create request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags to be added to a new threat list resource.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#CreateThreatIntelSetResponse": { - "type": "structure", - "members": { - "ThreatIntelSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the ThreatIntelSet resource.
", - "smithy.api#jsonName": "threatIntelSetId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#Criterion": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#String" - }, - "value": { - "target": "com.amazonaws.guardduty#Condition" - } - }, - "com.amazonaws.guardduty#CriterionKey": { - "type": "enum", - "members": { - "EC2_INSTANCE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2_INSTANCE_ARN" - } - }, - "SCAN_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_ID" - } - }, - "ACCOUNT_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_ID" - } - }, - "GUARDDUTY_FINDING_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GUARDDUTY_FINDING_ID" - } - }, - "SCAN_START_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_START_TIME" - } - }, - "SCAN_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_STATUS" - } - }, - "SCAN_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCAN_TYPE" - } - } - } - }, - "com.amazonaws.guardduty#DNSLogsConfigurationResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.guardduty#DataSourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Denotes whether DNS logs is enabled as a data source.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the status of DNS logs as a data source.
" - } - }, - "com.amazonaws.guardduty#DataSource": { - "type": "enum", - "members": { - "FLOW_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLOW_LOGS" - } - }, - "CLOUD_TRAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUD_TRAIL" - } - }, - "DNS_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DNS_LOGS" - } - }, - "S3_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_LOGS" - } - }, - "KUBERNETES_AUDIT_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KUBERNETES_AUDIT_LOGS" - } - }, - "EC2_MALWARE_SCAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2_MALWARE_SCAN" - } - } - } - }, - "com.amazonaws.guardduty#DataSourceConfigurations": { - "type": "structure", - "members": { - "S3Logs": { - "target": "com.amazonaws.guardduty#S3LogsConfiguration", - "traits": { - "smithy.api#documentation": "Describes whether S3 data event logs are enabled as a data source.
", - "smithy.api#jsonName": "s3Logs" - } - }, - "Kubernetes": { - "target": "com.amazonaws.guardduty#KubernetesConfiguration", - "traits": { - "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", - "smithy.api#jsonName": "kubernetes" - } - }, - "MalwareProtection": { - "target": "com.amazonaws.guardduty#MalwareProtectionConfiguration", - "traits": { - "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", - "smithy.api#jsonName": "malwareProtection" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about which data sources are enabled.
" - } - }, - "com.amazonaws.guardduty#DataSourceConfigurationsResult": { - "type": "structure", - "members": { - "CloudTrail": { - "target": "com.amazonaws.guardduty#CloudTrailConfigurationResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object that contains information on the status of CloudTrail as a data source.
", - "smithy.api#jsonName": "cloudTrail", - "smithy.api#required": {} - } - }, - "DNSLogs": { - "target": "com.amazonaws.guardduty#DNSLogsConfigurationResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object that contains information on the status of DNS logs as a data source.
", - "smithy.api#jsonName": "dnsLogs", - "smithy.api#required": {} - } - }, - "FlowLogs": { - "target": "com.amazonaws.guardduty#FlowLogsConfigurationResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object that contains information on the status of VPC flow logs as a data\n source.
", - "smithy.api#jsonName": "flowLogs", - "smithy.api#required": {} - } - }, - "S3Logs": { - "target": "com.amazonaws.guardduty#S3LogsConfigurationResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object that contains information on the status of S3 Data event logs as a data\n source.
", - "smithy.api#jsonName": "s3Logs", - "smithy.api#required": {} - } - }, - "Kubernetes": { - "target": "com.amazonaws.guardduty#KubernetesConfigurationResult", - "traits": { - "smithy.api#documentation": "An object that contains information on the status of all Kubernetes data sources.
", - "smithy.api#jsonName": "kubernetes" - } - }, - "MalwareProtection": { - "target": "com.amazonaws.guardduty#MalwareProtectionConfigurationResult", - "traits": { - "smithy.api#documentation": "Describes the configuration of Malware Protection data sources.
", - "smithy.api#jsonName": "malwareProtection" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the status of data sources for the detector.
" - } - }, - "com.amazonaws.guardduty#DataSourceFreeTrial": { - "type": "structure", - "members": { - "FreeTrialDaysRemaining": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "A value that specifies the number of days left to use each enabled data source.
", - "smithy.api#jsonName": "freeTrialDaysRemaining" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about which data sources are enabled for the GuardDuty member\n account.
" - } - }, - "com.amazonaws.guardduty#DataSourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#DataSource" - } - }, - "com.amazonaws.guardduty#DataSourceStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#DataSourcesFreeTrial": { - "type": "structure", - "members": { - "CloudTrail": { - "target": "com.amazonaws.guardduty#DataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether any Amazon Web Services CloudTrail management event logs are enabled as data sources.
", - "smithy.api#jsonName": "cloudTrail" - } - }, - "DnsLogs": { - "target": "com.amazonaws.guardduty#DataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether any DNS logs are enabled as data sources.
", - "smithy.api#jsonName": "dnsLogs" - } - }, - "FlowLogs": { - "target": "com.amazonaws.guardduty#DataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether any VPC Flow logs are enabled as data sources.
", - "smithy.api#jsonName": "flowLogs" - } - }, - "S3Logs": { - "target": "com.amazonaws.guardduty#DataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether any S3 data event logs are enabled as data sources.
", - "smithy.api#jsonName": "s3Logs" - } - }, - "Kubernetes": { - "target": "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", - "smithy.api#jsonName": "kubernetes" - } - }, - "MalwareProtection": { - "target": "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", - "smithy.api#jsonName": "malwareProtection" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about which data sources are enabled for the GuardDuty member\n account.
" - } - }, - "com.amazonaws.guardduty#DeclineInvitations": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeclineInvitationsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeclineInvitationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Declines invitations sent to the current member account by Amazon Web Services accounts specified by\n their account IDs.
", - "smithy.api#http": { - "method": "POST", - "uri": "/invitation/decline", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#DeclineInvitationsRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member\n account that you want to decline invitations from.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeclineInvitationsResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DefaultServerSideEncryption": { - "type": "structure", - "members": { - "EncryptionType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The type of encryption used for objects within the S3 bucket.
", - "smithy.api#jsonName": "encryptionType" - } - }, - "KmsMasterKeyArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket\n EncryptionType is aws:kms.
Contains information on the server side encryption method used in the S3 bucket. See\n S3\n Server-Side Encryption for more information.
" - } - }, - "com.amazonaws.guardduty#DeleteDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeleteDetectorRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeleteDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an Amazon GuardDuty detector that is specified by the detector ID.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/detector/{DetectorId}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#DeleteDetectorRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeleteDetectorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DeleteFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeleteFilterRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeleteFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the filter specified by the filter name.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/detector/{DetectorId}/filter/{FilterName}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#DeleteFilterRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the filter is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FilterName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the filter that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "filterName", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeleteFilterResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DeleteIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeleteIPSetRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeleteIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP\n lists in the console user interface.
The unique ID of the detector associated with the IPSet.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "IpSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID of the IPSet to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "ipSetId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeleteIPSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DeleteInvitations": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeleteInvitationsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeleteInvitationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes invitations sent to the current member account by Amazon Web Services accounts specified by\n their account IDs.
", - "smithy.api#http": { - "method": "POST", - "uri": "/invitation/delete", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#DeleteInvitationsRequest": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member\n account that you want to delete invitations from.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeleteInvitationsResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DeleteMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeleteMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeleteMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes GuardDuty member accounts (to the current GuardDuty administrator account)\n specified by the account IDs.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty for a member\n account in your organization.
The unique ID of the detector of the GuardDuty account whose members you want to\n delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts that you want to delete.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeleteMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The accounts that could not be processed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DeletePublishingDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeletePublishingDestinationRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeletePublishingDestinationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the publishing definition with the specified destinationId.
The unique ID of the detector associated with the publishing destination to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "DestinationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ID of the publishing destination to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeletePublishingDestinationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DeleteThreatIntelSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DeleteThreatIntelSetRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DeleteThreatIntelSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#DeleteThreatIntelSetRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the threatIntelSet is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "ThreatIntelSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID of the threatIntelSet that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "threatIntelSetId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DeleteThreatIntelSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DescribeMalwareScans": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DescribeMalwareScansRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DescribeMalwareScansResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of malware scans. Each member account can view the malware scans for their\n own accounts. An administrator can view the malware scans for all the member accounts.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/malware-scans", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Scans", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#DescribeMalwareScansRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", - "smithy.api#jsonName": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#IntegerValueWithMax", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#jsonName": "maxResults" - } - }, - "FilterCriteria": { - "target": "com.amazonaws.guardduty#FilterCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
", - "smithy.api#jsonName": "filterCriteria" - } - }, - "SortCriteria": { - "target": "com.amazonaws.guardduty#SortCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria used for sorting scan entries. The \n attributeName\n is required and it must be\n scanStartTime.
Contains information about malware scans.
", - "smithy.api#jsonName": "scans", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DescribeOrganizationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DescribeOrganizationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DescribeOrganizationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about the account selected as the delegated administrator for\n GuardDuty.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/admin", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#DescribeOrganizationConfigurationRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector to retrieve information about the delegated administrator\n from.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill\n nextToken in the request with the value of NextToken from the\n previous response to continue listing data.
Indicates whether GuardDuty is automatically enabled for accounts added to the\n organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results.
Indicates whether the maximum number of allowed member accounts are already associated\n with the delegated administrator account for your organization.
", - "smithy.api#jsonName": "memberAccountLimitReached", - "smithy.api#required": {} - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#OrganizationDataSourceConfigurationsResult", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "Describes which data sources are enabled automatically for member accounts.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#OrganizationFeaturesConfigurationsResults", - "traits": { - "smithy.api#documentation": "A list of features that are configured for this organization.
", - "smithy.api#jsonName": "features" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - }, - "AutoEnableOrganizationMembers": { - "target": "com.amazonaws.guardduty#AutoEnableMembers", - "traits": { - "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in \n the organization individually.
Returns information about the publishing destination specified by the provided\n destinationId.
The unique ID of the detector associated with the publishing destination to\n retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "DestinationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ID of the publishing destination to retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DescribePublishingDestinationResponse": { - "type": "structure", - "members": { - "DestinationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the publishing destination.
", - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } - }, - "DestinationType": { - "target": "com.amazonaws.guardduty#DestinationType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of publishing destination. Currently, only Amazon S3 buckets are\n supported.
", - "smithy.api#jsonName": "destinationType", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.guardduty#PublishingStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the publishing destination.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - }, - "PublishingFailureStartTimestamp": { - "target": "com.amazonaws.guardduty#Long", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time, in epoch millisecond format, at which GuardDuty was first unable to publish\n findings to the destination.
", - "smithy.api#jsonName": "publishingFailureStartTimestamp", - "smithy.api#required": {} - } - }, - "DestinationProperties": { - "target": "com.amazonaws.guardduty#DestinationProperties", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A DestinationProperties object that includes the DestinationArn\n and KmsKeyArn of the publishing destination.
The unique ID of the publishing destination.
", - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } - }, - "DestinationType": { - "target": "com.amazonaws.guardduty#DestinationType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of resource used for the publishing destination. Currently, only Amazon S3\n buckets are supported.
", - "smithy.api#jsonName": "destinationType", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.guardduty#PublishingStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the publishing destination.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the publishing destination, including the ID, type, and\n status.
" - } - }, - "com.amazonaws.guardduty#DestinationProperties": { - "type": "structure", - "members": { - "DestinationArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ARN of the resource to publish to.
\nTo specify an S3 bucket folder use the following format:\n arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/\n
The ARN of the KMS key to use for encryption.
", - "smithy.api#jsonName": "kmsKeyArn" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3\n bucket, and the ARN of the KMS key to use to encrypt published findings.
" - } - }, - "com.amazonaws.guardduty#DestinationType": { - "type": "enum", - "members": { - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#Destinations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Destination" - } - }, - "com.amazonaws.guardduty#Detection": { - "type": "structure", - "members": { - "Anomaly": { - "target": "com.amazonaws.guardduty#Anomaly", - "traits": { - "smithy.api#documentation": "The details about the anomalous activity that caused GuardDuty to \n generate the finding.
", - "smithy.api#jsonName": "anomaly" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the detected behavior.
" - } - }, - "com.amazonaws.guardduty#DetectorAdditionalConfiguration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#FeatureAdditionalConfiguration", - "traits": { - "smithy.api#documentation": "Name of the additional configuration.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "Status of the additional configuration.
", - "smithy.api#jsonName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the additional configuration for a feature in your GuardDuty account.
" - } - }, - "com.amazonaws.guardduty#DetectorAdditionalConfigurationResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#FeatureAdditionalConfiguration", - "traits": { - "smithy.api#documentation": "Name of the additional configuration.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "Status of the additional configuration.
", - "smithy.api#jsonName": "status" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the additional configuration was last updated. This is in UTC\n format.
", - "smithy.api#jsonName": "updatedAt" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the additional configuration.
" - } - }, - "com.amazonaws.guardduty#DetectorAdditionalConfigurationResults": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurationResult" - } - }, - "com.amazonaws.guardduty#DetectorAdditionalConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#DetectorAdditionalConfiguration" - } - }, - "com.amazonaws.guardduty#DetectorFeature": { - "type": "enum", - "members": { - "S3_DATA_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_DATA_EVENTS" - } - }, - "EKS_AUDIT_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_AUDIT_LOGS" - } - }, - "EBS_MALWARE_PROTECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" - } - }, - "RDS_LOGIN_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_LOGIN_EVENTS" - } - }, - "EKS_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" - } - }, - "LAMBDA_NETWORK_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" - } - }, - "RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNTIME_MONITORING" - } - } - } - }, - "com.amazonaws.guardduty#DetectorFeatureConfiguration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#DetectorFeature", - "traits": { - "smithy.api#documentation": "The name of the feature.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "The status of the feature.
", - "smithy.api#jsonName": "status" - } - }, - "AdditionalConfiguration": { - "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurations", - "traits": { - "smithy.api#documentation": "Additional configuration for a resource.
", - "smithy.api#jsonName": "additionalConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a GuardDuty feature.
" - } - }, - "com.amazonaws.guardduty#DetectorFeatureConfigurationResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#DetectorFeatureResult", - "traits": { - "smithy.api#documentation": "Indicates the name of the feature that can be enabled for the detector.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the feature that is enabled for the detector.
", - "smithy.api#jsonName": "status" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the feature object was updated.
", - "smithy.api#jsonName": "updatedAt" - } - }, - "AdditionalConfiguration": { - "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurationResults", - "traits": { - "smithy.api#documentation": "Additional configuration for a resource.
", - "smithy.api#jsonName": "additionalConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a GuardDuty feature.
" - } - }, - "com.amazonaws.guardduty#DetectorFeatureConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#DetectorFeatureConfiguration" - } - }, - "com.amazonaws.guardduty#DetectorFeatureConfigurationsResults": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#DetectorFeatureConfigurationResult" - } - }, - "com.amazonaws.guardduty#DetectorFeatureResult": { - "type": "enum", - "members": { - "FLOW_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLOW_LOGS" - } - }, - "CLOUD_TRAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUD_TRAIL" - } - }, - "DNS_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DNS_LOGS" - } - }, - "S3_DATA_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_DATA_EVENTS" - } - }, - "EKS_AUDIT_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_AUDIT_LOGS" - } - }, - "EBS_MALWARE_PROTECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" - } - }, - "RDS_LOGIN_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_LOGIN_EVENTS" - } - }, - "EKS_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" - } - }, - "LAMBDA_NETWORK_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" - } - }, - "RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNTIME_MONITORING" - } - } - } - }, - "com.amazonaws.guardduty#DetectorId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#DetectorIds": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#DetectorId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#DetectorStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#DisableOrganizationAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Removes the existing GuardDuty delegated\n administrator of the organization. Only the organization's management account can run this \n API operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/admin/disable", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#DisableOrganizationAdminAccountRequest": { - "type": "structure", - "members": { - "AdminAccountId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated\n administrator.
", - "smithy.api#jsonName": "adminAccountId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DisableOrganizationAdminAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DisassociateFromAdministratorAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
The unique ID of the detector of the GuardDuty member account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DisassociateFromMasterAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DisassociateFromMasterAccountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DisassociateFromMasterAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This operation is deprecated, use DisassociateFromAdministratorAccount instead" - }, - "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/master/disassociate", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#DisassociateFromMasterAccountRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "This input is deprecated, use DisassociateFromAdministratorAccountRequest instead" + "com.amazonaws.guardduty#AcceptAdministratorInvitationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AdministratorId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The account ID of the GuardDuty administrator account whose invitation you're\n accepting.
", + "smithy.api#jsonName": "administratorId", + "smithy.api#required": {} + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value that is used to validate the administrator account to the member\n account.
", + "smithy.api#jsonName": "invitationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DisassociateFromMasterAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#deprecated": { - "message": "This output is deprecated, use DisassociateFromAdministratorAccountResponse instead" - }, - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DisassociateMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#DisassociateMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#DisassociateMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates GuardDuty member accounts (from the current administrator account) specified\n by the account IDs.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your organization.
The unique ID of the detector of the GuardDuty account whose members you want to\n disassociate from the administrator account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts that you want to disassociate from\n the administrator account.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#DisassociateMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#DnsRequestAction": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The domain information for the DNS query.
", - "smithy.api#jsonName": "domain" - } - }, - "Protocol": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The network connection protocol observed in the activity that prompted GuardDuty to\n generate the finding.
", - "smithy.api#jsonName": "protocol" - } - }, - "Blocked": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether the targeted port is blocked.
", - "smithy.api#jsonName": "blocked" - } - }, - "DomainWithSuffix": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The second and top level domain involved in the \n activity that prompted GuardDuty to generate this finding.
", - "smithy.api#jsonName": "domainWithSuffix" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the DNS_REQUEST action described in this finding.
" - } - }, - "com.amazonaws.guardduty#DomainDetails": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The domain information for the Amazon Web Services API call.
", - "smithy.api#jsonName": "domain" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the domain.
" - } - }, - "com.amazonaws.guardduty#Double": { - "type": "double" - }, - "com.amazonaws.guardduty#EbsSnapshotPreservation": { - "type": "enum", - "members": { - "NO_RETENTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_RETENTION" - } - }, - "RETENTION_WITH_FINDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETENTION_WITH_FINDING" - } - } - } - }, - "com.amazonaws.guardduty#EbsVolumeDetails": { - "type": "structure", - "members": { - "ScannedVolumeDetails": { - "target": "com.amazonaws.guardduty#VolumeDetails", - "traits": { - "smithy.api#documentation": "List of EBS volumes that were scanned.
", - "smithy.api#jsonName": "scannedVolumeDetails" - } - }, - "SkippedVolumeDetails": { - "target": "com.amazonaws.guardduty#VolumeDetails", - "traits": { - "smithy.api#documentation": "List of EBS volumes that were skipped from the malware scan.
", - "smithy.api#jsonName": "skippedVolumeDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
" - } - }, - "com.amazonaws.guardduty#EbsVolumeScanDetails": { - "type": "structure", - "members": { - "ScanId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Unique Id of the malware scan that generated the finding.
", - "smithy.api#jsonName": "scanId" - } - }, - "ScanStartedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "Returns the start date and time of the malware scan.
", - "smithy.api#jsonName": "scanStartedAt" - } - }, - "ScanCompletedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "Returns the completion date and time of the malware scan.
", - "smithy.api#jsonName": "scanCompletedAt" - } - }, - "TriggerFindingId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "GuardDuty finding ID that triggered a malware scan.
", - "smithy.api#jsonName": "triggerFindingId" - } - }, - "Sources": { - "target": "com.amazonaws.guardduty#Sources", - "traits": { - "smithy.api#documentation": "Contains list of threat intelligence sources used to detect threats.
", - "smithy.api#jsonName": "sources" - } - }, - "ScanDetections": { - "target": "com.amazonaws.guardduty#ScanDetections", - "traits": { - "smithy.api#documentation": "Contains a complete view providing malware scan result details.
", - "smithy.api#jsonName": "scanDetections" - } - }, - "ScanType": { - "target": "com.amazonaws.guardduty#ScanType", - "traits": { - "smithy.api#documentation": "Specifies the scan type that invoked the malware scan.
", - "smithy.api#jsonName": "scanType" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details from the malware scan that created a finding.
" - } - }, - "com.amazonaws.guardduty#EbsVolumesResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.guardduty#DataSourceStatus", - "traits": { - "smithy.api#documentation": "Describes whether scanning EBS volumes is enabled as a data source.
", - "smithy.api#jsonName": "status" - } - }, - "Reason": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a\n data source.
", - "smithy.api#jsonName": "reason" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
" - } - }, - "com.amazonaws.guardduty#EcsClusterDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the ECS Cluster.
", - "smithy.api#jsonName": "name" - } - }, - "Arn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the cluster.
", - "smithy.api#jsonName": "arn" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The status of the ECS cluster.
", - "smithy.api#jsonName": "status" - } - }, - "ActiveServicesCount": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The number of services that are running on the cluster in an ACTIVE state.
", - "smithy.api#jsonName": "activeServicesCount" - } - }, - "RegisteredContainerInstancesCount": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The number of container instances registered into the cluster.
", - "smithy.api#jsonName": "registeredContainerInstancesCount" - } - }, - "RunningTasksCount": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING state.
", - "smithy.api#jsonName": "runningTasksCount" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "The tags of the ECS Cluster.
", - "smithy.api#jsonName": "tags" - } - }, - "TaskDetails": { - "target": "com.amazonaws.guardduty#EcsTaskDetails", - "traits": { - "smithy.api#documentation": "Contains information about the details of the ECS Task.
", - "smithy.api#jsonName": "taskDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
" - } - }, - "com.amazonaws.guardduty#EcsTaskDetails": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
", - "smithy.api#jsonName": "arn" - } - }, - "DefinitionArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ARN of the task definition that creates the task.
", - "smithy.api#jsonName": "definitionArn" - } - }, - "Version": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The version counter for the task.
", - "smithy.api#jsonName": "version" - } - }, - "TaskCreatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task was created.
", - "smithy.api#jsonName": "createdAt" - } - }, - "StartedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The Unix timestamp for the time when the task started.
", - "smithy.api#jsonName": "startedAt" - } - }, - "StartedBy": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Contains the tag specified when a task is started.
", - "smithy.api#jsonName": "startedBy" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "The tags of the ECS Task.
", - "smithy.api#jsonName": "tags" - } - }, - "Volumes": { - "target": "com.amazonaws.guardduty#Volumes", - "traits": { - "smithy.api#documentation": "The list of data volume definitions for the task.
", - "smithy.api#jsonName": "volumes" - } - }, - "Containers": { - "target": "com.amazonaws.guardduty#Containers", - "traits": { - "smithy.api#documentation": "The containers that's associated with the task.
", - "smithy.api#jsonName": "containers" - } - }, - "Group": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the task group that's associated with the task.
", - "smithy.api#jsonName": "group" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the task in an ECS cluster.
" - } - }, - "com.amazonaws.guardduty#EksClusterDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "EKS cluster name.
", - "smithy.api#jsonName": "name" - } - }, - "Arn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "EKS cluster ARN.
", - "smithy.api#jsonName": "arn" - } - }, - "VpcId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The VPC ID to which the EKS cluster is attached.
", - "smithy.api#jsonName": "vpcId" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The EKS cluster status.
", - "smithy.api#jsonName": "status" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "The EKS cluster tags.
", - "smithy.api#jsonName": "tags" - } - }, - "CreatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp when the EKS cluster was created.
", - "smithy.api#jsonName": "createdAt" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
" - } - }, - "com.amazonaws.guardduty#Email": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.guardduty#EnableOrganizationAdminAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Designates an Amazon Web Services account within the organization as your GuardDuty delegated\n administrator. Only the organization's management account can run this \n API operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/admin/enable", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest": { - "type": "structure", - "members": { - "AdminAccountId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.
", - "smithy.api#jsonName": "adminAccountId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#Eq": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Equals": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Evidence": { - "type": "structure", - "members": { - "ThreatIntelligenceDetails": { - "target": "com.amazonaws.guardduty#ThreatIntelligenceDetails", - "traits": { - "smithy.api#documentation": "A list of threat intelligence details related to the evidence.
", - "smithy.api#jsonName": "threatIntelligenceDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the reason that the finding was generated.
" - } - }, - "com.amazonaws.guardduty#FargateDetails": { - "type": "structure", - "members": { - "Issues": { - "target": "com.amazonaws.guardduty#Issues", - "traits": { - "smithy.api#documentation": "Runtime coverage issues identified for the resource running on AWS Fargate.
", - "smithy.api#jsonName": "issues" - } - }, - "ManagementType": { - "target": "com.amazonaws.guardduty#ManagementType", - "traits": { - "smithy.api#documentation": "Indicates how the GuardDuty security agent is managed for this resource.
\n\n AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this resource.
\n MANUAL indicates that you are responsible to deploy, update, and manage the GuardDuty \n security agent updates for this resource.
\n DISABLED indicates that the deployment of the GuardDuty security agent is disabled for this resource.
Contains information about AWS Fargate details associated with \n an Amazon ECS cluster.
" - } - }, - "com.amazonaws.guardduty#FeatureAdditionalConfiguration": { - "type": "enum", - "members": { - "EKS_ADDON_MANAGEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_ADDON_MANAGEMENT" - } - }, - "ECS_FARGATE_AGENT_MANAGEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECS_FARGATE_AGENT_MANAGEMENT" - } - } - } - }, - "com.amazonaws.guardduty#FeatureStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.guardduty#Feedback": { - "type": "enum", - "members": { - "USEFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USEFUL" - } - }, - "NOT_USEFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_USEFUL" - } - } - } - }, - "com.amazonaws.guardduty#FilePaths": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#ScanFilePath" - } - }, - "com.amazonaws.guardduty#FilterAction": { - "type": "enum", - "members": { - "NOOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOOP" - } - }, - "ARCHIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARCHIVE" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#FilterCondition": { - "type": "structure", - "members": { - "EqualsValue": { - "target": "com.amazonaws.guardduty#NonEmptyString", - "traits": { - "smithy.api#documentation": "Represents an equal\n condition to be applied to\n a single field when querying for scan entries.
", - "smithy.api#jsonName": "equalsValue" - } - }, - "GreaterThan": { - "target": "com.amazonaws.guardduty#LongValue", - "traits": { - "smithy.api#documentation": "Represents a greater than condition to be applied to a single field\n when querying for scan entries.
", - "smithy.api#jsonName": "greaterThan" - } - }, - "LessThan": { - "target": "com.amazonaws.guardduty#LongValue", - "traits": { - "smithy.api#documentation": "Represents a less than condition to be applied to a single field when\n querying for scan entries.
", - "smithy.api#jsonName": "lessThan" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the condition.
" - } - }, - "com.amazonaws.guardduty#FilterCriteria": { - "type": "structure", - "members": { - "FilterCriterion": { - "target": "com.amazonaws.guardduty#FilterCriterionList", - "traits": { - "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
", - "smithy.api#jsonName": "filterCriterion" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
" - } - }, - "com.amazonaws.guardduty#FilterCriterion": { - "type": "structure", - "members": { - "CriterionKey": { - "target": "com.amazonaws.guardduty#CriterionKey", - "traits": { - "smithy.api#documentation": "An enum value representing possible scan properties to match with given scan\n entries.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
Contains information about the condition.
", - "smithy.api#jsonName": "filterCondition" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.\n Irrespective of using any filter criteria, an administrator account can view the scan entries\n for all of its member accounts. However, each member account can view the scan entries only\n for their own account.
" - } - }, - "com.amazonaws.guardduty#FilterCriterionList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#FilterCriterion" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.guardduty#FilterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.guardduty#FilterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 64 - } - } - }, - "com.amazonaws.guardduty#FilterNames": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#FilterName" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#FilterRank": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.guardduty#Finding": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the account in which the finding was generated.
", - "smithy.api#jsonName": "accountId", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ARN of the finding.
", - "smithy.api#jsonName": "arn", - "smithy.api#required": {} - } - }, - "Confidence": { - "target": "com.amazonaws.guardduty#Double", - "traits": { - "smithy.api#documentation": "The confidence score for the finding.
", - "smithy.api#jsonName": "confidence" - } - }, - "CreatedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time and date when the finding was created.
", - "smithy.api#jsonName": "createdAt", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The description of the finding.
", - "smithy.api#jsonName": "description" - } - }, - "Id": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the finding.
", - "smithy.api#jsonName": "id", - "smithy.api#required": {} - } - }, - "Partition": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The partition associated with the finding.
", - "smithy.api#jsonName": "partition" - } - }, - "Region": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Region where the finding was generated.
", - "smithy.api#jsonName": "region", - "smithy.api#required": {} - } - }, - "Resource": { - "target": "com.amazonaws.guardduty#Resource", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#jsonName": "resource", - "smithy.api#required": {} - } - }, - "SchemaVersion": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The version of the schema used for the finding.
", - "smithy.api#jsonName": "schemaVersion", - "smithy.api#required": {} - } - }, - "Service": { - "target": "com.amazonaws.guardduty#Service", - "traits": { - "smithy.api#jsonName": "service" - } - }, - "Severity": { - "target": "com.amazonaws.guardduty#Double", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The severity of the finding.
", - "smithy.api#jsonName": "severity", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The title of the finding.
", - "smithy.api#jsonName": "title" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#FindingType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of finding.
", - "smithy.api#jsonName": "type", - "smithy.api#required": {} - } - }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The time and date when the finding was last updated.
", - "smithy.api#jsonName": "updatedAt", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the finding that is generated when abnormal or suspicious\n activity is detected.
" - } - }, - "com.amazonaws.guardduty#FindingCriteria": { - "type": "structure", - "members": { - "Criterion": { - "target": "com.amazonaws.guardduty#Criterion", - "traits": { - "smithy.api#documentation": "Represents a map of finding properties that match specified conditions and values when\n querying findings.
", - "smithy.api#jsonName": "criterion" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the criteria used for querying findings.
" - } - }, - "com.amazonaws.guardduty#FindingId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#FindingIds": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#FindingId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#FindingPublishingFrequency": { - "type": "enum", - "members": { - "FIFTEEN_MINUTES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIFTEEN_MINUTES" - } - }, - "ONE_HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_HOUR" - } - }, - "SIX_HOURS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SIX_HOURS" - } - } - } - }, - "com.amazonaws.guardduty#FindingStatisticType": { - "type": "enum", - "members": { - "COUNT_BY_SEVERITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT_BY_SEVERITY" - } - } - } - }, - "com.amazonaws.guardduty#FindingStatisticTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#FindingStatisticType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.guardduty#FindingStatistics": { - "type": "structure", - "members": { - "CountBySeverity": { - "target": "com.amazonaws.guardduty#CountBySeverity", - "traits": { - "smithy.api#documentation": "Represents a map of severity to count statistics for a set of findings.
", - "smithy.api#jsonName": "countBySeverity" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about finding statistics.
" - } - }, - "com.amazonaws.guardduty#FindingType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#FindingTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#FindingType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#Findings": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Finding" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#FlagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#FlowLogsConfigurationResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.guardduty#DataSourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Denotes whether VPC flow logs is enabled as a data source.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the status of VPC flow logs as a data source.
" - } - }, - "com.amazonaws.guardduty#FreeTrialFeatureConfigurationResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#FreeTrialFeatureResult", - "traits": { - "smithy.api#documentation": "The name of the feature for which the free trial is configured.
", - "smithy.api#jsonName": "name" - } - }, - "FreeTrialDaysRemaining": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The number of the remaining free trial days for the feature.
", - "smithy.api#jsonName": "freeTrialDaysRemaining" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the free trial period for a feature.
" - } - }, - "com.amazonaws.guardduty#FreeTrialFeatureConfigurationsResults": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#FreeTrialFeatureConfigurationResult" - } - }, - "com.amazonaws.guardduty#FreeTrialFeatureResult": { - "type": "enum", - "members": { - "FLOW_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLOW_LOGS" - } - }, - "CLOUD_TRAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUD_TRAIL" - } - }, - "DNS_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DNS_LOGS" - } - }, - "S3_DATA_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_DATA_EVENTS" - } - }, - "EKS_AUDIT_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_AUDIT_LOGS" - } - }, - "EBS_MALWARE_PROTECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" - } - }, - "RDS_LOGIN_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_LOGIN_EVENTS" - } - }, - "EKS_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" - } - }, - "LAMBDA_NETWORK_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" - } - }, - "FARGATE_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FARGATE_RUNTIME_MONITORING" - } - }, - "EC2_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2_RUNTIME_MONITORING" - } - } - } - }, - "com.amazonaws.guardduty#GeoLocation": { - "type": "structure", - "members": { - "Lat": { - "target": "com.amazonaws.guardduty#Double", - "traits": { - "smithy.api#documentation": "The latitude information of the remote IP address.
", - "smithy.api#jsonName": "lat" - } - }, - "Lon": { - "target": "com.amazonaws.guardduty#Double", - "traits": { - "smithy.api#documentation": "The longitude information of the remote IP address.
", - "smithy.api#jsonName": "lon" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the location of the remote IP address.
" - } - }, - "com.amazonaws.guardduty#GetAdministratorAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetAdministratorAccountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetAdministratorAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Provides the details of the GuardDuty administrator account associated with the current\n GuardDuty member account.
\nIf the organization's management account or a delegated administrator runs this API, \n it will return success (HTTP 200) but no content.
The unique ID of the detector of the GuardDuty member account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetAdministratorAccountResponse": { - "type": "structure", - "members": { - "Administrator": { - "target": "com.amazonaws.guardduty#Administrator", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The administrator account details.
", - "smithy.api#jsonName": "administrator", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetCoverageStatistics": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetCoverageStatisticsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetCoverageStatisticsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you\n can retrieve the statistics for all the resources associated with the active member accounts\n in your organization who have enabled EKS Runtime Monitoring and have the GuardDuty agent running\n on their EKS nodes.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/coverage/statistics", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetCoverageStatisticsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the GuardDuty detector associated to the coverage statistics.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FilterCriteria": { - "target": "com.amazonaws.guardduty#CoverageFilterCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria used to filter the coverage statistics
", - "smithy.api#jsonName": "filterCriteria" - } - }, - "StatisticsType": { - "target": "com.amazonaws.guardduty#CoverageStatisticsTypeList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Represents the statistics type used to aggregate the coverage details.
", - "smithy.api#jsonName": "statisticsType", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetCoverageStatisticsResponse": { - "type": "structure", - "members": { - "CoverageStatistics": { - "target": "com.amazonaws.guardduty#CoverageStatistics", - "traits": { - "smithy.api#documentation": "Represents the count aggregated by the statusCode and\n resourceType.
Retrieves an Amazon GuardDuty detector specified by the detectorId.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetDetectorRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that you want to get.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetDetectorResponse": { - "type": "structure", - "members": { - "CreatedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The timestamp of when the detector was created.
", - "smithy.api#jsonName": "createdAt" - } - }, - "FindingPublishingFrequency": { - "target": "com.amazonaws.guardduty#FindingPublishingFrequency", - "traits": { - "smithy.api#documentation": "The publishing frequency of the finding.
", - "smithy.api#jsonName": "findingPublishingFrequency" - } - }, - "ServiceRole": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The GuardDuty service role.
", - "smithy.api#jsonName": "serviceRole", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.guardduty#DetectorStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The detector status.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The last-updated timestamp for the detector.
", - "smithy.api#jsonName": "updatedAt" - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "Describes which data sources are enabled for the detector.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags of the detector resource.
", - "smithy.api#jsonName": "tags" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#DetectorFeatureConfigurationsResults", - "traits": { - "smithy.api#documentation": "Describes the features that have been enabled for the detector.
", - "smithy.api#jsonName": "features" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetFilterRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the details of the filter specified by the filter name.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/filter/{FilterName}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetFilterRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the filter is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FilterName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the filter you want to get.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "filterName", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetFilterResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#FilterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the filter.
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.guardduty#FilterDescription", - "traits": { - "smithy.api#documentation": "The description of the filter.
", - "smithy.api#jsonName": "description" - } - }, - "Action": { - "target": "com.amazonaws.guardduty#FilterAction", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Specifies the action that is to be applied to the findings that match the filter.
", - "smithy.api#jsonName": "action", - "smithy.api#required": {} - } - }, - "Rank": { - "target": "com.amazonaws.guardduty#FilterRank", - "traits": { - "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.
", - "smithy.api#jsonName": "rank" - } - }, - "FindingCriteria": { - "target": "com.amazonaws.guardduty#FindingCriteria", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings.
", - "smithy.api#jsonName": "findingCriteria", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags of the filter resource.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetFindingsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Describes Amazon GuardDuty findings specified by finding IDs.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/findings/get", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetFindingsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to\n retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FindingIds": { - "target": "com.amazonaws.guardduty#FindingIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the findings that you want to retrieve.
", - "smithy.api#jsonName": "findingIds", - "smithy.api#required": {} - } - }, - "SortCriteria": { - "target": "com.amazonaws.guardduty#SortCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria used for sorting findings.
", - "smithy.api#jsonName": "sortCriteria" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetFindingsResponse": { - "type": "structure", - "members": { - "Findings": { - "target": "com.amazonaws.guardduty#Findings", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of findings.
", - "smithy.api#jsonName": "findings", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetFindingsStatistics": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetFindingsStatisticsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetFindingsStatisticsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists Amazon GuardDuty findings statistics for the specified detector ID.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/findings/statistics", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetFindingsStatisticsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings' statistics you\n want to retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FindingStatisticTypes": { - "target": "com.amazonaws.guardduty#FindingStatisticTypes", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The types of finding statistics to retrieve.
", - "smithy.api#jsonName": "findingStatisticTypes", - "smithy.api#required": {} - } - }, - "FindingCriteria": { - "target": "com.amazonaws.guardduty#FindingCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria that is used for querying findings.
", - "smithy.api#jsonName": "findingCriteria" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetFindingsStatisticsResponse": { - "type": "structure", - "members": { - "FindingStatistics": { - "target": "com.amazonaws.guardduty#FindingStatistics", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The finding statistics object.
", - "smithy.api#jsonName": "findingStatistics", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetIPSetRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves the IPSet specified by the ipSetId.
The unique ID of the detector that the IPSet is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "IpSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID of the IPSet to retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "ipSetId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetIPSetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The user-friendly name for the IPSet.
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.guardduty#IpSetFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The format of the file that contains the IPSet.
", - "smithy.api#jsonName": "format", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the file that contains the IPSet.
", - "smithy.api#jsonName": "location", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.guardduty#IpSetStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of IPSet file that was uploaded.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags of the IPSet resource.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetInvitationsCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetInvitationsCountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetInvitationsCountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the count of all GuardDuty membership invitations that were sent to the current\n member account except the currently accepted invitation.
", - "smithy.api#http": { - "method": "GET", - "uri": "/invitation/count", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetInvitationsCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetInvitationsCountResponse": { - "type": "structure", - "members": { - "InvitationsCount": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The number of received invitations.
", - "smithy.api#jsonName": "invitationsCount" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetMalwareScanSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetMalwareScanSettingsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetMalwareScanSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the details of the malware scan settings.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/malware-scan-settings", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetMalwareScanSettingsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the scan setting is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetMalwareScanSettingsResponse": { - "type": "structure", - "members": { - "ScanResourceCriteria": { - "target": "com.amazonaws.guardduty#ScanResourceCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria to be used in the filter for scanning resources.
", - "smithy.api#jsonName": "scanResourceCriteria" - } - }, - "EbsSnapshotPreservation": { - "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", - "traits": { - "smithy.api#documentation": "An enum value representing possible snapshot preservation settings.
", - "smithy.api#jsonName": "ebsSnapshotPreservation" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetMasterAccount": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetMasterAccountRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetMasterAccountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This operation is deprecated, use GetAdministratorAccount instead" - }, - "smithy.api#documentation": "Provides the details for the GuardDuty administrator account associated with the current\n GuardDuty member account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/master", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetMasterAccountRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "This input is deprecated, use GetAdministratorAccountRequest instead" - }, - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetMasterAccountResponse": { - "type": "structure", - "members": { - "Master": { - "target": "com.amazonaws.guardduty#Master", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The administrator account details.
", - "smithy.api#jsonName": "master", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#deprecated": { - "message": "This output is deprecated, use GetAdministratorAccountResponse instead" + "com.amazonaws.guardduty#AcceptAdministratorInvitationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetMemberDetectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetMemberDetectorsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetMemberDetectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Describes which data sources are enabled for the member account's detector.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/member/detector/get", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetMemberDetectorsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The detector ID for the administrator account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The account ID of the member account.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetMemberDetectorsResponse": { - "type": "structure", - "members": { - "MemberDataSourceConfigurations": { - "target": "com.amazonaws.guardduty#MemberDataSourceConfigurations", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "An object that describes which data sources are enabled for a member account.
", - "smithy.api#jsonName": "members", - "smithy.api#required": {} - } - }, - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of member account IDs that were unable to be processed along with an explanation\n for why they were not processed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves GuardDuty member accounts (of the current GuardDuty administrator account)\n specified by the account IDs.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/member/get", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetMembersRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account whose members you want to\n retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts that you want to describe.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetMembersResponse": { - "type": "structure", - "members": { - "Members": { - "target": "com.amazonaws.guardduty#Members", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of members.
", - "smithy.api#jsonName": "members", - "smithy.api#required": {} - } - }, - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetRemainingFreeTrialDays": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Provides the number of days left for each data source used in the free trial\n period.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/freeTrial/daysRemaining", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#documentation": "A list of account identifiers of the GuardDuty member account.
", - "smithy.api#jsonName": "accountIds" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse": { - "type": "structure", - "members": { - "Accounts": { - "target": "com.amazonaws.guardduty#AccountFreeTrialInfos", - "traits": { - "smithy.api#documentation": "The member accounts which were included in a request and were processed\n successfully.
", - "smithy.api#jsonName": "accounts" - } - }, - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#documentation": "The member account that was included in a request but for which the request could not be\n processed.
", - "smithy.api#jsonName": "unprocessedAccounts" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetThreatIntelSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetThreatIntelSetRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetThreatIntelSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#GetThreatIntelSetRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the threatIntelSet is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "ThreatIntelSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID of the threatIntelSet that you want to get.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "threatIntelSetId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetThreatIntelSetResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#Name", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.guardduty#ThreatIntelSetFormat", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The format of the threatIntelSet.
", - "smithy.api#jsonName": "format", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The URI of the file that contains the ThreatIntelSet.
", - "smithy.api#jsonName": "location", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.guardduty#ThreatIntelSetStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of threatIntelSet file uploaded.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags of the threat list resource.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#GetUsageStatistics": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#GetUsageStatisticsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#GetUsageStatisticsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector\n ID. For newly enabled detectors or data sources, the cost returned will include only the usage\n so far under 30 days. This may differ from the cost metrics in the console, which project\n usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/usage/statistics", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#GetUsageStatisticsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose usage statistics you\n want to retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "UsageStatisticType": { - "target": "com.amazonaws.guardduty#UsageStatisticType", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of usage statistics to retrieve.
", - "smithy.api#jsonName": "usageStatisticsType", - "smithy.api#required": {} - } - }, - "UsageCriteria": { - "target": "com.amazonaws.guardduty#UsageCriteria", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Represents the criteria used for querying usage.
", - "smithy.api#jsonName": "usageCriteria", - "smithy.api#required": {} - } - }, - "Unit": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The currency unit you would like to view your usage statistics in. Current valid values\n are USD.
", - "smithy.api#jsonName": "unit" - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response.
", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results after the first\n page.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#GetUsageStatisticsResponse": { - "type": "structure", - "members": { - "UsageStatistics": { - "target": "com.amazonaws.guardduty#UsageStatistics", - "traits": { - "smithy.api#documentation": "The usage statistics object. If a UsageStatisticType was provided, the objects\n representing other types will be null.
", - "smithy.api#jsonName": "usageStatistics" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#Groups": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#GuardDutyAPIService": { - "type": "service", - "version": "2017-11-28", - "operations": [ - { - "target": "com.amazonaws.guardduty#AcceptAdministratorInvitation" + "com.amazonaws.guardduty#AcceptInvitation": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#AcceptInvitationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#AcceptInvitationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use AcceptAdministratorInvitation instead" + }, + "smithy.api#documentation": "Accepts the invitation to be monitored by a GuardDuty administrator account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/master", + "code": 200 + } + } }, - { - "target": "com.amazonaws.guardduty#AcceptInvitation" + "com.amazonaws.guardduty#AcceptInvitationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MasterId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The account ID of the GuardDuty administrator account whose invitation you're\n accepting.
", + "smithy.api#jsonName": "masterId", + "smithy.api#required": {} + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The value that is used to validate the administrator account to the member\n account.
", + "smithy.api#jsonName": "invitationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use AcceptAdministratorInvitationRequest instead" + }, + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.guardduty#ArchiveFindings" + "com.amazonaws.guardduty#AcceptInvitationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use AcceptAdministratorInvitationResponse instead" + }, + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.guardduty#CreateDetector" + "com.amazonaws.guardduty#AccessControlList": { + "type": "structure", + "members": { + "AllowsPublicReadAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public read access for the bucket is enabled through an\n Access Control List (ACL).
", + "smithy.api#jsonName": "allowsPublicReadAccess" + } + }, + "AllowsPublicWriteAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public write access for the bucket is enabled through an\n Access Control List (ACL).
", + "smithy.api#jsonName": "allowsPublicWriteAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the current access control policies for the bucket.
" + } }, - { - "target": "com.amazonaws.guardduty#CreateFilter" + "com.amazonaws.guardduty#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "__type" + } + } + }, + "traits": { + "smithy.api#documentation": "An access denied exception object.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } }, - { - "target": "com.amazonaws.guardduty#CreateIPSet" + "com.amazonaws.guardduty#AccessKeyDetails": { + "type": "structure", + "members": { + "AccessKeyId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The access key ID of the user.
", + "smithy.api#jsonName": "accessKeyId" + } + }, + "PrincipalId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The principal ID of the user.
", + "smithy.api#jsonName": "principalId" + } + }, + "UserName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the user.
", + "smithy.api#jsonName": "userName" + } + }, + "UserType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of the user.
", + "smithy.api#jsonName": "userType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the access keys.
" + } }, - { - "target": "com.amazonaws.guardduty#CreateMembers" + "com.amazonaws.guardduty#AccountDetail": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The member account ID.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.guardduty#Email", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the member account.
", + "smithy.api#jsonName": "email", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the account.
" + } }, - { - "target": "com.amazonaws.guardduty#CreatePublishingDestination" + "com.amazonaws.guardduty#AccountDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountDetail" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.guardduty#CreateSampleFindings" + "com.amazonaws.guardduty#AccountFreeTrialInfo": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The account identifier of the GuardDuty member account.
", + "smithy.api#jsonName": "accountId" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourcesFreeTrial", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes the data source enabled for the GuardDuty member account.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#FreeTrialFeatureConfigurationsResults", + "traits": { + "smithy.api#documentation": "A list of features enabled for the GuardDuty account.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details of the GuardDuty member account that uses a free trial service.
" + } }, - { - "target": "com.amazonaws.guardduty#CreateThreatIntelSet" + "com.amazonaws.guardduty#AccountFreeTrialInfos": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountFreeTrialInfo" + } }, - { - "target": "com.amazonaws.guardduty#DeclineInvitations" + "com.amazonaws.guardduty#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + } + } }, - { - "target": "com.amazonaws.guardduty#DeleteDetector" + "com.amazonaws.guardduty#AccountIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } }, - { - "target": "com.amazonaws.guardduty#DeleteFilter" + "com.amazonaws.guardduty#AccountLevelPermissions": { + "type": "structure", + "members": { + "BlockPublicAccess": { + "target": "com.amazonaws.guardduty#BlockPublicAccess", + "traits": { + "smithy.api#documentation": "Describes the S3 Block Public Access settings of the bucket's parent account.
", + "smithy.api#jsonName": "blockPublicAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the account level permissions on the S3 bucket.
" + } }, - { - "target": "com.amazonaws.guardduty#DeleteInvitations" + "com.amazonaws.guardduty#Action": { + "type": "structure", + "members": { + "ActionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The GuardDuty finding activity type.
", + "smithy.api#jsonName": "actionType" + } + }, + "AwsApiCallAction": { + "target": "com.amazonaws.guardduty#AwsApiCallAction", + "traits": { + "smithy.api#documentation": "Information about the AWS_API_CALL action described in this finding.
", + "smithy.api#jsonName": "awsApiCallAction" + } + }, + "DnsRequestAction": { + "target": "com.amazonaws.guardduty#DnsRequestAction", + "traits": { + "smithy.api#documentation": "Information about the DNS_REQUEST action described in this finding.
", + "smithy.api#jsonName": "dnsRequestAction" + } + }, + "NetworkConnectionAction": { + "target": "com.amazonaws.guardduty#NetworkConnectionAction", + "traits": { + "smithy.api#documentation": "Information about the NETWORK_CONNECTION action described in this finding.
", + "smithy.api#jsonName": "networkConnectionAction" + } + }, + "PortProbeAction": { + "target": "com.amazonaws.guardduty#PortProbeAction", + "traits": { + "smithy.api#documentation": "Information about the PORT_PROBE action described in this finding.
", + "smithy.api#jsonName": "portProbeAction" + } + }, + "KubernetesApiCallAction": { + "target": "com.amazonaws.guardduty#KubernetesApiCallAction", + "traits": { + "smithy.api#documentation": "Information about the Kubernetes API call action described in this finding.
", + "smithy.api#jsonName": "kubernetesApiCallAction" + } + }, + "RdsLoginAttemptAction": { + "target": "com.amazonaws.guardduty#RdsLoginAttemptAction", + "traits": { + "smithy.api#documentation": "Information about RDS_LOGIN_ATTEMPT action described in this finding.
Information whether the user has the permission to use a specific Kubernetes API.
", + "smithy.api#jsonName": "kubernetesPermissionCheckedDetails" + } + }, + "KubernetesRoleBindingDetails": { + "target": "com.amazonaws.guardduty#KubernetesRoleBindingDetails", + "traits": { + "smithy.api#documentation": "Information about the role binding that grants the permission defined in a Kubernetes role.
", + "smithy.api#jsonName": "kubernetesRoleBindingDetails" + } + }, + "KubernetesRoleDetails": { + "target": "com.amazonaws.guardduty#KubernetesRoleDetails", + "traits": { + "smithy.api#documentation": "Information about the Kubernetes role name and role type.
", + "smithy.api#jsonName": "kubernetesRoleDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about actions.
" + } }, - { - "target": "com.amazonaws.guardduty#DeleteIPSet" + "com.amazonaws.guardduty#AddonDetails": { + "type": "structure", + "members": { + "AddonVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Version of the installed EKS add-on.
", + "smithy.api#jsonName": "addonVersion" + } + }, + "AddonStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Status of the installed EKS add-on.
", + "smithy.api#jsonName": "addonStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the installed EKS add-on (GuardDuty security agent).
" + } }, - { - "target": "com.amazonaws.guardduty#DeleteMembers" + "com.amazonaws.guardduty#AdminAccount": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID for the account.
", + "smithy.api#jsonName": "adminAccountId" + } + }, + "AdminStatus": { + "target": "com.amazonaws.guardduty#AdminStatus", + "traits": { + "smithy.api#documentation": "Indicates whether the account is enabled as the delegated administrator.
", + "smithy.api#jsonName": "adminStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "The account within the organization specified as the GuardDuty delegated\n administrator.
" + } }, - { - "target": "com.amazonaws.guardduty#DeletePublishingDestination" + "com.amazonaws.guardduty#AdminAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AdminAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } }, - { - "target": "com.amazonaws.guardduty#DeleteThreatIntelSet" + "com.amazonaws.guardduty#AdminStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_IN_PROGRESS" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } }, - { - "target": "com.amazonaws.guardduty#DescribeMalwareScans" + "com.amazonaws.guardduty#Administrator": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the account used as the administrator account.
", + "smithy.api#jsonName": "accountId" + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The value that is used to validate the administrator account to the member\n account.
", + "smithy.api#jsonName": "invitationId" + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the relationship between the administrator and member accounts.
", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the administrator account and invitation.
" + } }, - { - "target": "com.amazonaws.guardduty#DescribeOrganizationConfiguration" + "com.amazonaws.guardduty#AffectedResources": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#String" + } }, - { - "target": "com.amazonaws.guardduty#DescribePublishingDestination" + "com.amazonaws.guardduty#AgentDetails": { + "type": "structure", + "members": { + "Version": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Version of the installed GuardDuty security agent.
", + "smithy.api#jsonName": "version" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the installed GuardDuty security agent.
" + } }, - { - "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccount" + "com.amazonaws.guardduty#Anomaly": { + "type": "structure", + "members": { + "Profiles": { + "target": "com.amazonaws.guardduty#AnomalyProfiles", + "traits": { + "smithy.api#documentation": "Information about the types of profiles.
", + "smithy.api#jsonName": "profiles" + } + }, + "Unusual": { + "target": "com.amazonaws.guardduty#AnomalyUnusual", + "traits": { + "smithy.api#documentation": "Information about the behavior of the anomalies.
", + "smithy.api#jsonName": "unusual" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the anomalies.
" + } }, - { - "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccount" + "com.amazonaws.guardduty#AnomalyObject": { + "type": "structure", + "members": { + "ProfileType": { + "target": "com.amazonaws.guardduty#ProfileType", + "traits": { + "smithy.api#documentation": "The type of behavior of the profile.
", + "smithy.api#jsonName": "profileType" + } + }, + "ProfileSubtype": { + "target": "com.amazonaws.guardduty#ProfileSubtype", + "traits": { + "smithy.api#documentation": "The frequency of the anomaly.
", + "smithy.api#jsonName": "profileSubtype" + } + }, + "Observations": { + "target": "com.amazonaws.guardduty#Observations", + "traits": { + "smithy.api#documentation": "The recorded value.
", + "smithy.api#jsonName": "observations" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the unusual anomalies.
" + } }, - { - "target": "com.amazonaws.guardduty#DisassociateFromMasterAccount" + "com.amazonaws.guardduty#AnomalyProfileFeatureObjects": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#AnomalyObject" + } }, - { - "target": "com.amazonaws.guardduty#DisassociateMembers" + "com.amazonaws.guardduty#AnomalyProfileFeatures": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyProfileFeatureObjects" + } }, - { - "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccount" + "com.amazonaws.guardduty#AnomalyProfiles": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyProfileFeatures" + } }, - { - "target": "com.amazonaws.guardduty#GetAdministratorAccount" + "com.amazonaws.guardduty#AnomalyUnusual": { + "type": "structure", + "members": { + "Behavior": { + "target": "com.amazonaws.guardduty#Behavior", + "traits": { + "smithy.api#documentation": "The behavior of the anomalous activity that caused GuardDuty to \n generate the finding.
", + "smithy.api#jsonName": "behavior" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the behavior of the anomaly that is new to GuardDuty.
" + } }, - { - "target": "com.amazonaws.guardduty#GetCoverageStatistics" + "com.amazonaws.guardduty#AnomalyUnusualBehaviorFeature": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyObject" + } }, - { - "target": "com.amazonaws.guardduty#GetDetector" + "com.amazonaws.guardduty#ArchiveFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ArchiveFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ArchiveFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Archives GuardDuty findings that are specified by the list of finding IDs.
\nOnly the administrator account can archive findings. Member accounts don't have\n permission to archive findings from their accounts.
\nThe ID of the detector that specifies the GuardDuty service whose findings you want to\n archive.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the findings that you want to archive.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.guardduty#GetFindings" + "com.amazonaws.guardduty#ArchiveFindingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.guardduty#GetFindingsStatistics" + "com.amazonaws.guardduty#AutoEnableMembers": { + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } }, - { - "target": "com.amazonaws.guardduty#GetInvitationsCount" + "com.amazonaws.guardduty#AwsApiCallAction": { + "type": "structure", + "members": { + "Api": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services API name.
", + "smithy.api#jsonName": "api" + } + }, + "CallerType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services API caller type.
", + "smithy.api#jsonName": "callerType" + } + }, + "DomainDetails": { + "target": "com.amazonaws.guardduty#DomainDetails", + "traits": { + "smithy.api#documentation": "The domain information for the Amazon Web Services API call.
", + "smithy.api#jsonName": "domainDetails" + } + }, + "ErrorCode": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error code of the failed Amazon Web Services API action.
", + "smithy.api#jsonName": "errorCode" + } + }, + "UserAgent": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The agent through which the API request was made.
", + "smithy.api#jsonName": "userAgent" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#documentation": "The remote IP information of the connection that initiated the Amazon Web Services API call.
", + "smithy.api#jsonName": "remoteIpDetails" + } + }, + "ServiceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services service name whose API was invoked.
", + "smithy.api#jsonName": "serviceName" + } + }, + "RemoteAccountDetails": { + "target": "com.amazonaws.guardduty#RemoteAccountDetails", + "traits": { + "smithy.api#documentation": "The details of the Amazon Web Services account that made the API call. This field appears if the call\n was made from outside your account.
", + "smithy.api#jsonName": "remoteAccountDetails" + } + }, + "AffectedResources": { + "target": "com.amazonaws.guardduty#AffectedResources", + "traits": { + "smithy.api#documentation": "The details of the Amazon Web Services account that made the API call. This field identifies the\n resources that were affected by this API call.
", + "smithy.api#jsonName": "affectedResources" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the API action.
" + } }, - { - "target": "com.amazonaws.guardduty#GetIPSet" + "com.amazonaws.guardduty#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "__type" + } + } + }, + "traits": { + "smithy.api#documentation": "A bad request exception object.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.guardduty#GetMalwareScanSettings" + "com.amazonaws.guardduty#Behavior": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#AnomalyUnusualBehaviorFeature" + } }, - { - "target": "com.amazonaws.guardduty#GetMasterAccount" + "com.amazonaws.guardduty#BlockPublicAccess": { + "type": "structure", + "members": { + "IgnorePublicAcls": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if S3 Block Public Access is set to IgnorePublicAcls.
Indicates if S3 Block Public Access is set to RestrictPublicBuckets.
Indicates if S3 Block Public Access is set to BlockPublicAcls.
Indicates if S3 Block Public Access is set to BlockPublicPolicy.
Contains information on how the bucker owner's S3 Block Public Access settings are being\n applied to the S3 bucket. See S3 Block Public\n Access for more information.
" + } }, - { - "target": "com.amazonaws.guardduty#GetMemberDetectors" - }, - { - "target": "com.amazonaws.guardduty#GetMembers" + "com.amazonaws.guardduty#Boolean": { + "type": "boolean" + }, + "com.amazonaws.guardduty#BucketLevelPermissions": { + "type": "structure", + "members": { + "AccessControlList": { + "target": "com.amazonaws.guardduty#AccessControlList", + "traits": { + "smithy.api#documentation": "Contains information on how Access Control Policies are applied to the bucket.
", + "smithy.api#jsonName": "accessControlList" + } + }, + "BucketPolicy": { + "target": "com.amazonaws.guardduty#BucketPolicy", + "traits": { + "smithy.api#documentation": "Contains information on the bucket policies for the S3 bucket.
", + "smithy.api#jsonName": "bucketPolicy" + } + }, + "BlockPublicAccess": { + "target": "com.amazonaws.guardduty#BlockPublicAccess", + "traits": { + "smithy.api#documentation": "Contains information on which account level S3 Block Public Access settings are applied to\n the S3 bucket.
", + "smithy.api#jsonName": "blockPublicAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the bucket level permissions for the S3 bucket.
" + } }, - { - "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDays" + "com.amazonaws.guardduty#BucketPolicy": { + "type": "structure", + "members": { + "AllowsPublicReadAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public read access for the bucket is enabled through a\n bucket policy.
", + "smithy.api#jsonName": "allowsPublicReadAccess" + } + }, + "AllowsPublicWriteAccess": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A value that indicates whether public write access for the bucket is enabled through a\n bucket policy.
", + "smithy.api#jsonName": "allowsPublicWriteAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the current bucket policies for the S3 bucket.
" + } }, - { - "target": "com.amazonaws.guardduty#GetThreatIntelSet" + "com.amazonaws.guardduty#City": { + "type": "structure", + "members": { + "CityName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The city name of the remote IP address.
", + "smithy.api#jsonName": "cityName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the city associated with the IP address.
" + } }, - { - "target": "com.amazonaws.guardduty#GetUsageStatistics" + "com.amazonaws.guardduty#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } }, - { - "target": "com.amazonaws.guardduty#InviteMembers" + "com.amazonaws.guardduty#CloudTrailConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes whether CloudTrail is enabled as a data source for the detector.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the status of CloudTrail as a data source for the detector.
" + } }, - { - "target": "com.amazonaws.guardduty#ListCoverage" + "com.amazonaws.guardduty#Condition": { + "type": "structure", + "members": { + "Eq": { + "target": "com.amazonaws.guardduty#Eq", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents the equal condition to be applied to a single field when\n querying for findings.
", + "smithy.api#jsonName": "eq" + } + }, + "Neq": { + "target": "com.amazonaws.guardduty#Neq", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents the not equal condition to be applied to a single field\n when querying for findings.
", + "smithy.api#jsonName": "neq" + } + }, + "Gt": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a greater than condition to be applied to a single field\n when querying for findings.
", + "smithy.api#jsonName": "gt" + } + }, + "Gte": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a greater than or equal condition to be applied to a\n single field when querying for findings.
", + "smithy.api#jsonName": "gte" + } + }, + "Lt": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a less than condition to be applied to a single field when\n querying for findings.
", + "smithy.api#jsonName": "lt" + } + }, + "Lte": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Represents a less than or equal condition to be applied to a single\n field when querying for findings.
", + "smithy.api#jsonName": "lte" + } + }, + "Equals": { + "target": "com.amazonaws.guardduty#Equals", + "traits": { + "smithy.api#documentation": "Represents an equal\n condition to be applied to\n a single field when querying for findings.
", + "smithy.api#jsonName": "equals" + } + }, + "NotEquals": { + "target": "com.amazonaws.guardduty#NotEquals", + "traits": { + "smithy.api#documentation": "Represents a not equal\n condition to be applied\n to a single field when querying for findings.
", + "smithy.api#jsonName": "notEquals" + } + }, + "GreaterThan": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a greater than condition to be applied to a single field\n when querying for findings.
", + "smithy.api#jsonName": "greaterThan" + } + }, + "GreaterThanOrEqual": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a greater than or equal condition to be applied to a\n single field when querying for findings.
", + "smithy.api#jsonName": "greaterThanOrEqual" + } + }, + "LessThan": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a less than condition to be applied to a single field when\n querying for findings.
", + "smithy.api#jsonName": "lessThan" + } + }, + "LessThanOrEqual": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents a less than or equal condition to be applied to a single\n field when querying for findings.
", + "smithy.api#jsonName": "lessThanOrEqual" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the condition.
" + } }, - { - "target": "com.amazonaws.guardduty#ListDetectors" + "com.amazonaws.guardduty#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "__type" + } + } + }, + "traits": { + "smithy.api#documentation": "A request conflict exception object.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } }, - { - "target": "com.amazonaws.guardduty#ListFilters" + "com.amazonaws.guardduty#Container": { + "type": "structure", + "members": { + "ContainerRuntime": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The container runtime (such as, Docker or containerd) used to run the container.
", + "smithy.api#jsonName": "containerRuntime" + } + }, + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Container ID.
", + "smithy.api#jsonName": "id" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Container name.
", + "smithy.api#jsonName": "name" + } + }, + "Image": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Container image.
", + "smithy.api#jsonName": "image" + } + }, + "ImagePrefix": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Part of the image name before the last slash. For example, imagePrefix for\n public.ecr.aws/amazonlinux/amazonlinux:latest would be public.ecr.aws/amazonlinux. If the\n image name is relative and does not have a slash, this field is empty.
", + "smithy.api#jsonName": "imagePrefix" + } + }, + "VolumeMounts": { + "target": "com.amazonaws.guardduty#VolumeMounts", + "traits": { + "smithy.api#documentation": "Container volume mounts.
", + "smithy.api#jsonName": "volumeMounts" + } + }, + "SecurityContext": { + "target": "com.amazonaws.guardduty#SecurityContext", + "traits": { + "smithy.api#documentation": "Container security context.
", + "smithy.api#jsonName": "securityContext" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a container.
" + } }, - { - "target": "com.amazonaws.guardduty#ListFindings" + "com.amazonaws.guardduty#ContainerInstanceDetails": { + "type": "structure", + "members": { + "CoveredContainerInstances": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents the nodes in the Amazon ECS cluster that has a HEALTHY\n coverage status.
Represents total number of nodes in the Amazon ECS cluster.
", + "smithy.api#jsonName": "compatibleContainerInstances" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon EC2 instance that is running \n the Amazon ECS container.
" + } }, - { - "target": "com.amazonaws.guardduty#ListInvitations" + "com.amazonaws.guardduty#Containers": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Container" + } }, - { - "target": "com.amazonaws.guardduty#ListIPSets" + "com.amazonaws.guardduty#CountByCoverageStatus": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#CoverageStatus" + }, + "value": { + "target": "com.amazonaws.guardduty#Long" + } }, - { - "target": "com.amazonaws.guardduty#ListMembers" + "com.amazonaws.guardduty#CountByResourceType": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#ResourceType" + }, + "value": { + "target": "com.amazonaws.guardduty#Long" + } }, - { - "target": "com.amazonaws.guardduty#ListOrganizationAdminAccounts" + "com.amazonaws.guardduty#CountBySeverity": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" + }, + "value": { + "target": "com.amazonaws.guardduty#Integer" + } }, - { - "target": "com.amazonaws.guardduty#ListPublishingDestinations" + "com.amazonaws.guardduty#Country": { + "type": "structure", + "members": { + "CountryCode": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The country code of the remote IP address.
", + "smithy.api#jsonName": "countryCode" + } + }, + "CountryName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The country name of the remote IP address.
", + "smithy.api#jsonName": "countryName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the country where the remote IP address is located.
" + } }, - { - "target": "com.amazonaws.guardduty#ListTagsForResource" + "com.amazonaws.guardduty#CoverageEc2InstanceDetails": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon EC2 instance ID.
", + "smithy.api#jsonName": "instanceId" + } + }, + "InstanceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The instance type of the Amazon EC2 instance.
", + "smithy.api#jsonName": "instanceType" + } + }, + "ClusterArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The cluster ARN of the Amazon ECS cluster running on \n the Amazon EC2 instance.
", + "smithy.api#jsonName": "clusterArn" + } + }, + "AgentDetails": { + "target": "com.amazonaws.guardduty#AgentDetails", + "traits": { + "smithy.api#documentation": "Information about the installed security agent.
", + "smithy.api#jsonName": "agentDetails" + } + }, + "ManagementType": { + "target": "com.amazonaws.guardduty#ManagementType", + "traits": { + "smithy.api#documentation": "Indicates how the GuardDuty security agent is managed for this resource.
\n\n AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this resource.
\n MANUAL indicates that you are responsible to deploy, update, and manage the GuardDuty \n security agent updates for this resource.
The DISABLED status doesn't apply to Amazon \n EC2 instances and Amazon EKS clusters.
This API is also used when you use GuardDuty Runtime Monitoring \n for your Amazon EC2 instances (currently in preview\n release) and is subject to change. The use of this API is subject to Section 2 of the \n Amazon Web Services Service Terms (\"Betas and Previews\").
\nContains information about the Amazon EC2 instance runtime \n coverage details.
" + } }, - { - "target": "com.amazonaws.guardduty#ListThreatIntelSets" + "com.amazonaws.guardduty#CoverageEcsClusterDetails": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon ECS cluster.
", + "smithy.api#jsonName": "clusterName" + } + }, + "FargateDetails": { + "target": "com.amazonaws.guardduty#FargateDetails", + "traits": { + "smithy.api#documentation": "Information about the Fargate details associated with the Amazon \n ECS cluster.
", + "smithy.api#jsonName": "fargateDetails" + } + }, + "ContainerInstanceDetails": { + "target": "com.amazonaws.guardduty#ContainerInstanceDetails", + "traits": { + "smithy.api#documentation": "Information about the Amazon ECS container running on Amazon EC2 \n instance.
", + "smithy.api#jsonName": "containerInstanceDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about Amazon ECS cluster runtime coverage details.
" + } }, - { - "target": "com.amazonaws.guardduty#StartMalwareScan" + "com.amazonaws.guardduty#CoverageEksClusterDetails": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the EKS cluster.
", + "smithy.api#jsonName": "clusterName" + } + }, + "CoveredNodes": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#documentation": "Represents the nodes within the EKS cluster that have a HEALTHY coverage\n status.
Represents all the nodes within the EKS cluster in your account.
", + "smithy.api#jsonName": "compatibleNodes" + } + }, + "AddonDetails": { + "target": "com.amazonaws.guardduty#AddonDetails", + "traits": { + "smithy.api#documentation": "Information about the installed EKS add-on.
", + "smithy.api#jsonName": "addonDetails" + } + }, + "ManagementType": { + "target": "com.amazonaws.guardduty#ManagementType", + "traits": { + "smithy.api#documentation": "Indicates how the Amazon EKS add-on GuardDuty agent is managed for this EKS cluster.
\n\n AUTO_MANAGED indicates GuardDuty deploys and manages updates for this resource.
\n MANUAL indicates that you are responsible to deploy, update, and manage \n the Amazon EKS add-on GuardDuty agent for this resource.
Information about the EKS cluster that has a coverage status.
" + } }, - { - "target": "com.amazonaws.guardduty#StartMonitoringMembers" + "com.amazonaws.guardduty#CoverageFilterCondition": { + "type": "structure", + "members": { + "Equals": { + "target": "com.amazonaws.guardduty#Equals", + "traits": { + "smithy.api#documentation": "Represents an equal condition that is applied to a single field while retrieving the\n coverage details.
", + "smithy.api#jsonName": "equals" + } + }, + "NotEquals": { + "target": "com.amazonaws.guardduty#NotEquals", + "traits": { + "smithy.api#documentation": "Represents a not equal condition that is applied to a single field while retrieving the\n coverage details.
", + "smithy.api#jsonName": "notEquals" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
" + } }, - { - "target": "com.amazonaws.guardduty#StopMonitoringMembers" + "com.amazonaws.guardduty#CoverageFilterCriteria": { + "type": "structure", + "members": { + "FilterCriterion": { + "target": "com.amazonaws.guardduty#CoverageFilterCriterionList", + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
", + "smithy.api#jsonName": "filterCriterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the criteria used in the filter.
" + } }, - { - "target": "com.amazonaws.guardduty#TagResource" + "com.amazonaws.guardduty#CoverageFilterCriterion": { + "type": "structure", + "members": { + "CriterionKey": { + "target": "com.amazonaws.guardduty#CoverageFilterCriterionKey", + "traits": { + "smithy.api#documentation": "An enum value representing possible filter fields.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
Contains information about the condition.
", + "smithy.api#jsonName": "filterCondition" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
" + } }, - { - "target": "com.amazonaws.guardduty#UnarchiveFindings" + "com.amazonaws.guardduty#CoverageFilterCriterionKey": { + "type": "enum", + "members": { + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_NAME" + } + }, + "RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE_TYPE" + } + }, + "COVERAGE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COVERAGE_STATUS" + } + }, + "ADDON_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDON_VERSION" + } + }, + "MANAGEMENT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGEMENT_TYPE" + } + }, + "EKS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_CLUSTER_NAME" + } + }, + "ECS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_CLUSTER_NAME" + } + }, + "AGENT_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGENT_VERSION" + } + }, + "INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_ID" + } + }, + "CLUSTER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_ARN" + } + } + } }, - { - "target": "com.amazonaws.guardduty#UntagResource" + "com.amazonaws.guardduty#CoverageFilterCriterionList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#CoverageFilterCriterion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } }, - { - "target": "com.amazonaws.guardduty#UpdateDetector" + "com.amazonaws.guardduty#CoverageResource": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the resource.
", + "smithy.api#jsonName": "resourceId" + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector associated with the resource.
", + "smithy.api#jsonName": "detectorId" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The unique ID of the Amazon Web Services account.
", + "smithy.api#jsonName": "accountId" + } + }, + "ResourceDetails": { + "target": "com.amazonaws.guardduty#CoverageResourceDetails", + "traits": { + "smithy.api#documentation": "Information about the resource for which the coverage statistics are retrieved.
", + "smithy.api#jsonName": "resourceDetails" + } + }, + "CoverageStatus": { + "target": "com.amazonaws.guardduty#CoverageStatus", + "traits": { + "smithy.api#documentation": "Represents the status of the EKS cluster coverage.
", + "smithy.api#jsonName": "coverageStatus" + } + }, + "Issue": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the reason why a coverage status was UNHEALTHY for the EKS\n cluster.
The timestamp at which the coverage details for the resource were last updated. This is in\n UTC format.
", + "smithy.api#jsonName": "updatedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the resource of the GuardDuty account.
" + } }, - { - "target": "com.amazonaws.guardduty#UpdateFilter" + "com.amazonaws.guardduty#CoverageResourceDetails": { + "type": "structure", + "members": { + "EksClusterDetails": { + "target": "com.amazonaws.guardduty#CoverageEksClusterDetails", + "traits": { + "smithy.api#documentation": "EKS cluster details involved in the coverage statistics.
", + "smithy.api#jsonName": "eksClusterDetails" + } + }, + "ResourceType": { + "target": "com.amazonaws.guardduty#ResourceType", + "traits": { + "smithy.api#documentation": "The type of Amazon Web Services resource.
", + "smithy.api#jsonName": "resourceType" + } + }, + "EcsClusterDetails": { + "target": "com.amazonaws.guardduty#CoverageEcsClusterDetails", + "traits": { + "smithy.api#documentation": "Information about the Amazon ECS cluster that is assessed for \n runtime coverage.
", + "smithy.api#jsonName": "ecsClusterDetails" + } + }, + "Ec2InstanceDetails": { + "target": "com.amazonaws.guardduty#CoverageEc2InstanceDetails", + "traits": { + "smithy.api#documentation": "This API is also used when you use GuardDuty Runtime Monitoring \n for your Amazon EC2 instances (currently in preview\n release) and is subject to change. The use of this API is subject to Section 2 of the \n Amazon Web Services Service Terms (\"Betas and Previews\").
\nInformation about the Amazon EC2 instance assessed \n for runtime coverage.
", + "smithy.api#jsonName": "ec2InstanceDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the resource for each individual EKS cluster.
" + } }, - { - "target": "com.amazonaws.guardduty#UpdateFindingsFeedback" + "com.amazonaws.guardduty#CoverageResources": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#CoverageResource" + } }, - { - "target": "com.amazonaws.guardduty#UpdateIPSet" + "com.amazonaws.guardduty#CoverageSortCriteria": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.guardduty#CoverageSortKey", + "traits": { + "smithy.api#documentation": "Represents the field name used to sort the coverage details.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
The order in which the sorted findings are to be displayed.
", + "smithy.api#jsonName": "orderBy" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the sorting criteria used in the coverage statistics.
" + } }, - { - "target": "com.amazonaws.guardduty#UpdateMalwareScanSettings" + "com.amazonaws.guardduty#CoverageSortKey": { + "type": "enum", + "members": { + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER_NAME" + } + }, + "COVERAGE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COVERAGE_STATUS" + } + }, + "ISSUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISSUE" + } + }, + "ADDON_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADDON_VERSION" + } + }, + "UPDATED_AT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED_AT" + } + }, + "EKS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_CLUSTER_NAME" + } + }, + "ECS_CLUSTER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_CLUSTER_NAME" + } + }, + "INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSTANCE_ID" + } + } + } }, - { - "target": "com.amazonaws.guardduty#UpdateMemberDetectors" + "com.amazonaws.guardduty#CoverageStatistics": { + "type": "structure", + "members": { + "CountByResourceType": { + "target": "com.amazonaws.guardduty#CountByResourceType", + "traits": { + "smithy.api#documentation": "Represents coverage statistics for EKS clusters aggregated by resource type.
", + "smithy.api#jsonName": "countByResourceType" + } + }, + "CountByCoverageStatus": { + "target": "com.amazonaws.guardduty#CountByCoverageStatus", + "traits": { + "smithy.api#documentation": "Represents coverage statistics for EKS clusters aggregated by coverage status.
", + "smithy.api#jsonName": "countByCoverageStatus" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the coverage statistics for a resource.
" + } }, - { - "target": "com.amazonaws.guardduty#UpdateOrganizationConfiguration" + "com.amazonaws.guardduty#CoverageStatisticsType": { + "type": "enum", + "members": { + "COUNT_BY_RESOURCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_BY_RESOURCE_TYPE" + } + }, + "COUNT_BY_COVERAGE_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_BY_COVERAGE_STATUS" + } + } + } }, - { - "target": "com.amazonaws.guardduty#UpdatePublishingDestination" + "com.amazonaws.guardduty#CoverageStatisticsTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#CoverageStatisticsType" + } }, - { - "target": "com.amazonaws.guardduty#UpdateThreatIntelSet" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "GuardDuty", - "arnNamespace": "guardduty", - "cloudFormationName": "GuardDuty", - "cloudTrailEventSource": "guardduty.amazonaws.com", - "endpointPrefix": "guardduty" - }, - "aws.auth#sigv4": { - "name": "guardduty" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following foundational data sources - VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, DNS logs, Amazon EBS volume data, runtime activity belonging to container workloads, such \n as Amazon EKS, Amazon ECS (including Amazon Web Services Fargate), and Amazon EC2 instances.\n It uses threat intelligence\n feeds, such as lists of malicious IPs and domains, and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances\n and container workloads. For example, GuardDuty can detect compromised EC2 instances and\n container workloads serving malware, or mining bitcoin.
\nGuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as\n unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never\n been used, or unusual API calls like a password policy change to reduce password strength.
\nGuardDuty informs you about the status of your Amazon Web Services environment by producing security\n findings that you can view in the GuardDuty console or through Amazon EventBridge. For more\n information, see the \n Amazon\n GuardDuty User Guide\n .
", - "smithy.api#title": "Amazon GuardDuty", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "com.amazonaws.guardduty#CoverageStatus": { + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" } - ] } - ], - "rules": [ + } + }, + "com.amazonaws.guardduty#CreateDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateDetectorRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#CreateDetectorResponse" + }, + "errors": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.guardduty#BadRequestException" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a single Amazon GuardDuty detector. A detector is a resource that represents the\n GuardDuty service. To start using GuardDuty, you must create a detector in each Region where\n you enable the service. You can have only one detector per account per Region. All data\n sources are enabled in a new detector by default.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateDetectorRequest": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Boolean value that specifies whether the detector is to be enabled.
", + "smithy.api#jsonName": "enable", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + }, + "FindingPublishingFrequency": { + "target": "com.amazonaws.guardduty#FindingPublishingFrequency", + "traits": { + "smithy.api#documentation": "A value that specifies how frequently updated findings are exported.
", + "smithy.api#jsonName": "findingPublishingFrequency" } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://guardduty-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - }, - "aws-us-gov" - ] - } - ], - "endpoint": { - "url": "https://guardduty.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://guardduty-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://guardduty.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://guardduty.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "smithy.api#documentation": "Describes which data sources will be enabled for the detector.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new detector resource.
", + "smithy.api#jsonName": "tags" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfigurations", + "traits": { + "smithy.api#documentation": "A list of features that will be configured for the detector.
", + "smithy.api#jsonName": "features" } - ], - "type": "tree" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "traits": { + "smithy.api#input": {} } - ] }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.af-south-1.amazonaws.com" - } - }, - "params": { - "Region": "af-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-east-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-3", - "UseFIPS": false, - "UseDualStack": false - } + "com.amazonaws.guardduty#CreateDetectorResponse": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the created detector.
", + "smithy.api#jsonName": "detectorId" + } + }, + "UnprocessedDataSources": { + "target": "com.amazonaws.guardduty#UnprocessedDataSourcesResult", + "traits": { + "smithy.api#documentation": "Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the\n first time.
", + "smithy.api#jsonName": "unprocessedDataSources" + } + } }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateFilterRequest" }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.guardduty#CreateFilterResponse" }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a filter using the specified finding criteria. The maximum number of saved filters\n per Amazon Web Services account per Region is 100. For more information, see Quotas for GuardDuty.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/filter", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector belonging to the GuardDuty account that you want to create a filter\n for.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#FilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the filter. Valid characters include period (.), underscore (_), dash (-), and\n alphanumeric characters. A whitespace is considered to be an invalid character.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#FilterDescription", + "traits": { + "smithy.api#documentation": "The description of the filter. Valid characters include alphanumeric characters, and\n special characters such as hyphen, period, colon, underscore, parentheses ({ },\n [ ], and ( )), forward slash, horizontal tab, vertical tab,\n newline, form feed, return, and whitespace.
Specifies the action that is to be applied to the findings that match the filter.
", + "smithy.api#jsonName": "action" + } + }, + "Rank": { + "target": "com.amazonaws.guardduty#FilterRank", + "traits": { + "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.
", + "smithy.api#jsonName": "rank" + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings.
\nYou can only use the following attributes to query findings:
\naccountId
\nid
\nregion
\nseverity
\nTo filter on the basis of severity, the API and CLI use the following input list for\n the FindingCriteria\n condition:
\n\n Low: [\"1\", \"2\", \"3\"]\n
\n Medium: [\"4\", \"5\", \"6\"]\n
\n High: [\"7\", \"8\", \"9\"]\n
For more information, see Severity\n levels for GuardDuty findings.
\ntype
\nupdatedAt
\nType: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ\n depending on whether the value contains milliseconds.
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.outpostArn
\nresource.resourceType
\nresource.s3BucketDetails.publicAccess.effectivePermissions
\nresource.s3BucketDetails.name
\nresource.s3BucketDetails.tags.key
\nresource.s3BucketDetails.tags.value
\nresource.s3BucketDetails.type
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.errorCode
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.city.cityName
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.action.awsApiCallAction.remoteAccountDetails.affiliated
\nservice.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.kubernetesApiCallAction.namespace
\nservice.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
\nservice.action.kubernetesApiCallAction.requestUri
\nservice.action.kubernetesApiCallAction.statusCode
\nservice.action.networkConnectionAction.localIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.protocol
\nservice.action.awsApiCallAction.serviceName
\nservice.action.awsApiCallAction.remoteAccountDetails.accountId
\nservice.additionalInfo.threatListName
\nservice.resourceRole
\nresource.eksClusterDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.name
\nresource.kubernetesDetails.kubernetesWorkloadDetails.namespace
\nresource.kubernetesDetails.kubernetesUserDetails.username
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
\nresource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
\nservice.ebsVolumeScanDetails.scanId
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
\nservice.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
\nresource.ecsClusterDetails.name
\nresource.ecsClusterDetails.taskDetails.containers.image
\nresource.ecsClusterDetails.taskDetails.definitionArn
\nresource.containerDetails.image
\nresource.rdsDbInstanceDetails.dbInstanceIdentifier
\nresource.rdsDbInstanceDetails.dbClusterIdentifier
\nresource.rdsDbInstanceDetails.engine
\nresource.rdsDbUserDetails.user
\nresource.rdsDbInstanceDetails.tags.key
\nresource.rdsDbInstanceDetails.tags.value
\nservice.runtimeDetails.process.executableSha256
\nservice.runtimeDetails.process.name
\nservice.runtimeDetails.process.name
\nresource.lambdaDetails.functionName
\nresource.lambdaDetails.functionArn
\nresource.lambdaDetails.tags.key
\nresource.lambdaDetails.tags.value
\nThe idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new filter resource.
", + "smithy.api#jsonName": "tags" + } + } }, - { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ap-southeast-3.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-3", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateFilterResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the successfully created filter.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateIPSetRequest" }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.guardduty#CreateIPSetResponse" }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.eu-north-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-north-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new IPSet, which is called a trusted IP list in the console user interface. An\n IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services\n infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are\n included in IPSets. Only users from the administrator account can use this operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/ipset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateIPSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to create an IPSet\n for.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user-friendly name to identify the IPSet.
\nAllowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#IpSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the IPSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the IPSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Boolean value that indicates whether GuardDuty is to start using the uploaded\n IPSet.
", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new IP set resource.
", + "smithy.api#jsonName": "tags" + } + } }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.eu-south-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-south-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateIPSetResponse": { + "type": "structure", + "members": { + "IpSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the IPSet resource.
", + "smithy.api#jsonName": "ipSetId", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateMembersRequest" }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.guardduty#CreateMembersResponse" }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nAs a delegated administrator, using CreateMembers will enable GuardDuty in \n the added member accounts, with the exception of the\n organization delegated administrator account. A delegated administrator must enable GuardDuty \n prior to being added as a member.
When you use CreateMembers as an Organizations delegated \n administrator, GuardDuty applies your organization's auto-enable settings to the member\n accounts in this request, irrespective of the accounts being new or existing members. For \n more information about the existing auto-enable settings for your organization, see\n DescribeOrganizationConfiguration.
\nIf you are adding accounts by invitation, before using InviteMembers, use \n CreateMembers after GuardDuty has been enabled in potential member accounts.
If you disassociate a member from a GuardDuty \n delegated administrator, the member account details \n obtained from this API, including the associated email addresses, will be retained. \n This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to associate member\n accounts with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountDetails": { + "target": "com.amazonaws.guardduty#AccountDetails", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account ID and email address pairs of the accounts that you want to associate\n with the GuardDuty administrator account.
", + "smithy.api#jsonName": "accountDetails", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.me-south-1.amazonaws.com" - } - }, - "params": { - "Region": "me-south-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that include the accountIds of the unprocessed accounts and\n a result string that explains why each was unprocessed.
Creates a publishing destination to export findings to. The resource to export findings to\n must exist before you use this operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/publishingDestination", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreatePublishingDestinationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the GuardDuty detector associated with the publishing destination.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "DestinationType": { + "target": "com.amazonaws.guardduty#DestinationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of resource for the publishing destination. Currently only Amazon S3 buckets are\n supported.
", + "smithy.api#jsonName": "destinationType", + "smithy.api#required": {} + } + }, + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The properties of the publishing destination, including the ARNs for the destination and\n the KMS key used for encryption.
", + "smithy.api#jsonName": "destinationProperties", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + } }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreatePublishingDestinationResponse": { + "type": "structure", + "members": { + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the publishing destination that is created.
", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateSampleFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateSampleFindingsRequest" }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.guardduty#CreateSampleFindingsResponse" }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": true, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Generates sample findings of types specified by the list of finding types. If 'NULL' is\n specified for findingTypes, the API generates sample findings of all supported\n finding types.
The ID of the detector to create sample findings for.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FindingTypes": { + "target": "com.amazonaws.guardduty#FindingTypes", + "traits": { + "smithy.api#documentation": "The types of sample findings to generate.
", + "smithy.api#jsonName": "findingTypes" + } + } }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateSampleFindingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#CreateThreatIntelSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#CreateThreatIntelSetRequest" }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.guardduty#CreateThreatIntelSetResponse" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses.\n GuardDuty generates findings based on ThreatIntelSets. Only users of the administrator\n account can use this operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/threatintelset", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#CreateThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to create a\n threatIntelSet for.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#ThreatIntelSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the ThreatIntelSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the ThreatIntelSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A Boolean value that indicates whether GuardDuty is to start using the uploaded\n ThreatIntelSet.
", + "smithy.api#jsonName": "activate", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.guardduty#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the create request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags to be added to a new threat list resource.
", + "smithy.api#jsonName": "tags" + } + } }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#CreateThreatIntelSetResponse": { + "type": "structure", + "members": { + "ThreatIntelSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the ThreatIntelSet resource.
", + "smithy.api#jsonName": "threatIntelSetId", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#Criterion": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#String" }, - { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.cn-northwest-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-northwest-1", - "UseFIPS": false, - "UseDualStack": false - } + "value": { + "target": "com.amazonaws.guardduty#Condition" + } + }, + "com.amazonaws.guardduty#CriterionKey": { + "type": "enum", + "members": { + "EC2_INSTANCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_INSTANCE_ARN" + } + }, + "SCAN_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_ID" + } + }, + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_ID" + } + }, + "GUARDDUTY_FINDING_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDDUTY_FINDING_ID" + } + }, + "SCAN_START_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_START_TIME" + } + }, + "SCAN_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_STATUS" + } + }, + "SCAN_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCAN_TYPE" + } + } + } + }, + "com.amazonaws.guardduty#DNSLogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Denotes whether DNS logs is enabled as a data source.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "Contains information on the status of DNS logs as a data source.
" + } + }, + "com.amazonaws.guardduty#DataSource": { + "type": "enum", + "members": { + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "S3_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_LOGS" + } + }, + "KUBERNETES_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KUBERNETES_AUDIT_LOGS" + } + }, + "EC2_MALWARE_SCAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_MALWARE_SCAN" + } + } + } + }, + "com.amazonaws.guardduty#DataSourceConfigurations": { + "type": "structure", + "members": { + "S3Logs": { + "target": "com.amazonaws.guardduty#S3LogsConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs are enabled as a data source.
", + "smithy.api#jsonName": "s3Logs" + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#KubernetesConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", + "smithy.api#jsonName": "malwareProtection" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "Contains information about which data sources are enabled.
" + } + }, + "com.amazonaws.guardduty#DataSourceConfigurationsResult": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.guardduty#CloudTrailConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of CloudTrail as a data source.
", + "smithy.api#jsonName": "cloudTrail", + "smithy.api#required": {} + } + }, + "DNSLogs": { + "target": "com.amazonaws.guardduty#DNSLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of DNS logs as a data source.
", + "smithy.api#jsonName": "dnsLogs", + "smithy.api#required": {} + } + }, + "FlowLogs": { + "target": "com.amazonaws.guardduty#FlowLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of VPC flow logs as a data\n source.
", + "smithy.api#jsonName": "flowLogs", + "smithy.api#required": {} + } + }, + "S3Logs": { + "target": "com.amazonaws.guardduty#S3LogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that contains information on the status of S3 Data event logs as a data\n source.
", + "smithy.api#jsonName": "s3Logs", + "smithy.api#required": {} + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#KubernetesConfigurationResult", + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Kubernetes data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection data sources.
", + "smithy.api#jsonName": "malwareProtection" + } + } }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://guardduty.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "Contains information on the status of data sources for the detector.
" + } + }, + "com.amazonaws.guardduty#DataSourceFreeTrial": { + "type": "structure", + "members": { + "FreeTrialDaysRemaining": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "A value that specifies the number of days left to use each enabled data source.
", + "smithy.api#jsonName": "freeTrialDaysRemaining" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "Contains information about which data sources are enabled for the GuardDuty member\n account.
" + } + }, + "com.amazonaws.guardduty#DataSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DataSource" + } + }, + "com.amazonaws.guardduty#DataSourceStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#DataSourcesFreeTrial": { + "type": "structure", + "members": { + "CloudTrail": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any Amazon Web Services CloudTrail management event logs are enabled as data sources.
", + "smithy.api#jsonName": "cloudTrail" + } + }, + "DnsLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any DNS logs are enabled as data sources.
", + "smithy.api#jsonName": "dnsLogs" + } + }, + "FlowLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any VPC Flow logs are enabled as data sources.
", + "smithy.api#jsonName": "flowLogs" + } + }, + "S3Logs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any S3 data event logs are enabled as data sources.
", + "smithy.api#jsonName": "s3Logs" + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes logs are enabled as data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection is enabled as a data source.
", + "smithy.api#jsonName": "malwareProtection" + } + } }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "Contains information about which data sources are enabled for the GuardDuty member\n account.
" + } + }, + "com.amazonaws.guardduty#DeclineInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeclineInvitationsRequest" }, - { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.guardduty#DeclineInvitationsResponse" }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Declines invitations sent to the current member account by Amazon Web Services accounts specified by\n their account IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/invitation/decline", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeclineInvitationsRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member\n account that you want to decline invitations from.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeclineInvitationsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DefaultServerSideEncryption": { + "type": "structure", + "members": { + "EncryptionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of encryption used for objects within the S3 bucket.
", + "smithy.api#jsonName": "encryptionType" + } + }, + "KmsMasterKeyArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS encryption key. Only available if the bucket\n EncryptionType is aws:kms.
Contains information on the server side encryption method used in the S3 bucket. See\n S3\n Server-Side Encryption for more information.
" + } + }, + "com.amazonaws.guardduty#DeleteDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteDetectorRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.guardduty#DeleteDetectorResponse" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an Amazon GuardDuty detector that is specified by the detector ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteDetectorRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteDetectorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteFilterRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.guardduty#DeleteFilterResponse" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the filter specified by the filter name.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}/filter/{FilterName}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the filter is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FilterName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the filter that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "filterName", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://guardduty.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteFilterResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteIPSetRequest" }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.guardduty#DeleteIPSetResponse" }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the IPSet specified by the ipSetId. IPSets are called trusted IP\n lists in the console user interface.
The unique ID of the detector associated with the IPSet.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "IpSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the IPSet to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "ipSetId", + "smithy.api#required": {} + } + } }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteIPSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteInvitationsRequest" }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "output": { + "target": "com.amazonaws.guardduty#DeleteInvitationsResponse" }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes invitations sent to the current member account by Amazon Web Services accounts specified by\n their account IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/invitation/delete", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteInvitationsRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the Amazon Web Services accounts that sent invitations to the current member\n account that you want to delete invitations from.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteInvitationsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes GuardDuty member accounts (to the current GuardDuty administrator account)\n specified by the account IDs.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty for a member\n account in your organization.
The unique ID of the detector of the GuardDuty account whose members you want to\n delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts that you want to delete.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The accounts that could not be processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeletePublishingDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeletePublishingDestinationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeletePublishingDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the publishing definition with the specified destinationId.
The unique ID of the detector associated with the publishing destination to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the publishing destination to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeletePublishingDestinationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DeleteThreatIntelSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DeleteThreatIntelSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DeleteThreatIntelSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DeleteThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the threatIntelSet is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "ThreatIntelSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the threatIntelSet that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "threatIntelSetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DeleteThreatIntelSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DescribeMalwareScans": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DescribeMalwareScansRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DescribeMalwareScansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of malware scans. Each member account can view the malware scans for their\n own accounts. An administrator can view the malware scans for all the member accounts.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/malware-scans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Scans", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#DescribeMalwareScansRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#jsonName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#IntegerValueWithMax", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#jsonName": "maxResults" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.guardduty#FilterCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used for sorting scan entries. The \n attributeName\n is required and it must be\n scanStartTime.
Contains information about malware scans.
", + "smithy.api#jsonName": "scans", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DescribeOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DescribeOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DescribeOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the account selected as the delegated administrator for\n GuardDuty.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/admin", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#DescribeOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector to retrieve information about the delegated administrator\n from.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill\n nextToken in the request with the value of NextToken from the\n previous response to continue listing data.
Indicates whether GuardDuty is automatically enabled for accounts added to the\n organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results.
Indicates whether the maximum number of allowed member accounts are already associated\n with the delegated administrator account for your organization.
", + "smithy.api#jsonName": "memberAccountLimitReached", + "smithy.api#required": {} + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#OrganizationDataSourceConfigurationsResult", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources are enabled automatically for member accounts.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#OrganizationFeaturesConfigurationsResults", + "traits": { + "smithy.api#documentation": "A list of features that are configured for this organization.
", + "smithy.api#jsonName": "features" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + }, + "AutoEnableOrganizationMembers": { + "target": "com.amazonaws.guardduty#AutoEnableMembers", + "traits": { + "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in \n the organization individually.
Returns information about the publishing destination specified by the provided\n destinationId.
The unique ID of the detector associated with the publishing destination to\n retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the publishing destination to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DescribePublishingDestinationResponse": { + "type": "structure", + "members": { + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the publishing destination.
", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + }, + "DestinationType": { + "target": "com.amazonaws.guardduty#DestinationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of publishing destination. Currently, only Amazon S3 buckets are\n supported.
", + "smithy.api#jsonName": "destinationType", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#PublishingStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the publishing destination.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "PublishingFailureStartTimestamp": { + "target": "com.amazonaws.guardduty#Long", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time, in epoch millisecond format, at which GuardDuty was first unable to publish\n findings to the destination.
", + "smithy.api#jsonName": "publishingFailureStartTimestamp", + "smithy.api#required": {} + } + }, + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A DestinationProperties object that includes the DestinationArn\n and KmsKeyArn of the publishing destination.
The unique ID of the publishing destination.
", + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + }, + "DestinationType": { + "target": "com.amazonaws.guardduty#DestinationType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of resource used for the publishing destination. Currently, only Amazon S3\n buckets are supported.
", + "smithy.api#jsonName": "destinationType", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#PublishingStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the publishing destination.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the publishing destination, including the ID, type, and\n status.
" + } + }, + "com.amazonaws.guardduty#DestinationProperties": { + "type": "structure", + "members": { + "DestinationArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ARN of the resource to publish to.
\nTo specify an S3 bucket folder use the following format:\n arn:aws:s3:::DOC-EXAMPLE-BUCKET/myFolder/\n
The ARN of the KMS key to use for encryption.
", + "smithy.api#jsonName": "kmsKeyArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the Amazon Resource Name (ARN) of the resource to publish to, such as an S3\n bucket, and the ARN of the KMS key to use to encrypt published findings.
" + } + }, + "com.amazonaws.guardduty#DestinationType": { + "type": "enum", + "members": { + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#Destinations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Destination" + } + }, + "com.amazonaws.guardduty#Detection": { + "type": "structure", + "members": { + "Anomaly": { + "target": "com.amazonaws.guardduty#Anomaly", + "traits": { + "smithy.api#documentation": "The details about the anomalous activity that caused GuardDuty to \n generate the finding.
", + "smithy.api#jsonName": "anomaly" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the detected behavior.
" + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Status of the additional configuration.
", + "smithy.api#jsonName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration for a feature in your GuardDuty account.
" + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Status of the additional configuration.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the additional configuration was last updated. This is in UTC\n format.
", + "smithy.api#jsonName": "updatedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration.
" + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfigurationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurationResult" + } + }, + "com.amazonaws.guardduty#DetectorAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#DetectorFeature": { + "type": "enum", + "members": { + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNTIME_MONITORING" + } + } + } + }, + "com.amazonaws.guardduty#DetectorFeatureConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#DetectorFeature", + "traits": { + "smithy.api#documentation": "The name of the feature.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "The status of the feature.
", + "smithy.api#jsonName": "status" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurations", + "traits": { + "smithy.api#documentation": "Additional configuration for a resource.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a GuardDuty feature.
" + } + }, + "com.amazonaws.guardduty#DetectorFeatureConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#DetectorFeatureResult", + "traits": { + "smithy.api#documentation": "Indicates the name of the feature that can be enabled for the detector.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the feature that is enabled for the detector.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the feature object was updated.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#DetectorAdditionalConfigurationResults", + "traits": { + "smithy.api#documentation": "Additional configuration for a resource.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a GuardDuty feature.
" + } + }, + "com.amazonaws.guardduty#DetectorFeatureConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfiguration" + } + }, + "com.amazonaws.guardduty#DetectorFeatureConfigurationsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfigurationResult" + } + }, + "com.amazonaws.guardduty#DetectorFeatureResult": { + "type": "enum", + "members": { + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNTIME_MONITORING" + } + } + } + }, + "com.amazonaws.guardduty#DetectorId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#DetectorIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#DetectorId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#DetectorStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#DisableOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the existing GuardDuty delegated\n administrator of the organization. Only the organization's management account can run this \n API operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/admin/disable", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DisableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated\n administrator.
", + "smithy.api#jsonName": "adminAccountId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisableOrganizationAdminAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromAdministratorAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromAdministratorAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromMasterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisassociateFromMasterAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisassociateFromMasterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use DisassociateFromAdministratorAccount instead" + }, + "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/master/disassociate", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#DisassociateFromMasterAccountRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use DisassociateFromAdministratorAccountRequest instead" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisassociateFromMasterAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use DisassociateFromAdministratorAccountResponse instead" + }, + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DisassociateMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#DisassociateMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#DisassociateMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates GuardDuty member accounts (from the current administrator account) specified\n by the account IDs.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your organization.
The unique ID of the detector of the GuardDuty account whose members you want to\n disassociate from the administrator account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts that you want to disassociate from\n the administrator account.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#DisassociateMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#DnsRequestAction": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The domain information for the DNS query.
", + "smithy.api#jsonName": "domain" + } + }, + "Protocol": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The network connection protocol observed in the activity that prompted GuardDuty to\n generate the finding.
", + "smithy.api#jsonName": "protocol" + } + }, + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the targeted port is blocked.
", + "smithy.api#jsonName": "blocked" + } + }, + "DomainWithSuffix": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The second and top level domain involved in the \n activity that prompted GuardDuty to generate this finding.
", + "smithy.api#jsonName": "domainWithSuffix" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the DNS_REQUEST action described in this finding.
" + } + }, + "com.amazonaws.guardduty#DomainDetails": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The domain information for the Amazon Web Services API call.
", + "smithy.api#jsonName": "domain" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the domain.
" + } + }, + "com.amazonaws.guardduty#Double": { + "type": "double" + }, + "com.amazonaws.guardduty#EbsSnapshotPreservation": { + "type": "enum", + "members": { + "NO_RETENTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_RETENTION" + } + }, + "RETENTION_WITH_FINDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETENTION_WITH_FINDING" + } + } + } + }, + "com.amazonaws.guardduty#EbsVolumeDetails": { + "type": "structure", + "members": { + "ScannedVolumeDetails": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of EBS volumes that were scanned.
", + "smithy.api#jsonName": "scannedVolumeDetails" + } + }, + "SkippedVolumeDetails": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of EBS volumes that were skipped from the malware scan.
", + "smithy.api#jsonName": "skippedVolumeDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
" + } + }, + "com.amazonaws.guardduty#EbsVolumeScanDetails": { + "type": "structure", + "members": { + "ScanId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Unique Id of the malware scan that generated the finding.
", + "smithy.api#jsonName": "scanId" + } + }, + "ScanStartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "Returns the start date and time of the malware scan.
", + "smithy.api#jsonName": "scanStartedAt" + } + }, + "ScanCompletedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "Returns the completion date and time of the malware scan.
", + "smithy.api#jsonName": "scanCompletedAt" + } + }, + "TriggerFindingId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "GuardDuty finding ID that triggered a malware scan.
", + "smithy.api#jsonName": "triggerFindingId" + } + }, + "Sources": { + "target": "com.amazonaws.guardduty#Sources", + "traits": { + "smithy.api#documentation": "Contains list of threat intelligence sources used to detect threats.
", + "smithy.api#jsonName": "sources" + } + }, + "ScanDetections": { + "target": "com.amazonaws.guardduty#ScanDetections", + "traits": { + "smithy.api#documentation": "Contains a complete view providing malware scan result details.
", + "smithy.api#jsonName": "scanDetections" + } + }, + "ScanType": { + "target": "com.amazonaws.guardduty#ScanType", + "traits": { + "smithy.api#documentation": "Specifies the scan type that invoked the malware scan.
", + "smithy.api#jsonName": "scanType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details from the malware scan that created a finding.
" + } + }, + "com.amazonaws.guardduty#EbsVolumesResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#documentation": "Describes whether scanning EBS volumes is enabled as a data source.
", + "smithy.api#jsonName": "status" + } + }, + "Reason": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a\n data source.
", + "smithy.api#jsonName": "reason" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
" + } + }, + "com.amazonaws.guardduty#EcsClusterDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the ECS Cluster.
", + "smithy.api#jsonName": "name" + } + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the cluster.
", + "smithy.api#jsonName": "arn" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the ECS cluster.
", + "smithy.api#jsonName": "status" + } + }, + "ActiveServicesCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of services that are running on the cluster in an ACTIVE state.
", + "smithy.api#jsonName": "activeServicesCount" + } + }, + "RegisteredContainerInstancesCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of container instances registered into the cluster.
", + "smithy.api#jsonName": "registeredContainerInstancesCount" + } + }, + "RunningTasksCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING state.
", + "smithy.api#jsonName": "runningTasksCount" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the ECS Cluster.
", + "smithy.api#jsonName": "tags" + } + }, + "TaskDetails": { + "target": "com.amazonaws.guardduty#EcsTaskDetails", + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Task.
", + "smithy.api#jsonName": "taskDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
" + } + }, + "com.amazonaws.guardduty#EcsTaskDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
", + "smithy.api#jsonName": "arn" + } + }, + "DefinitionArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ARN of the task definition that creates the task.
", + "smithy.api#jsonName": "definitionArn" + } + }, + "Version": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version counter for the task.
", + "smithy.api#jsonName": "version" + } + }, + "TaskCreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "StartedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for the time when the task started.
", + "smithy.api#jsonName": "startedAt" + } + }, + "StartedBy": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Contains the tag specified when a task is started.
", + "smithy.api#jsonName": "startedBy" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the ECS Task.
", + "smithy.api#jsonName": "tags" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Volumes", + "traits": { + "smithy.api#documentation": "The list of data volume definitions for the task.
", + "smithy.api#jsonName": "volumes" + } + }, + "Containers": { + "target": "com.amazonaws.guardduty#Containers", + "traits": { + "smithy.api#documentation": "The containers that's associated with the task.
", + "smithy.api#jsonName": "containers" + } + }, + "Group": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the task group that's associated with the task.
", + "smithy.api#jsonName": "group" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the task in an ECS cluster.
" + } + }, + "com.amazonaws.guardduty#EksClusterDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EKS cluster name.
", + "smithy.api#jsonName": "name" + } + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EKS cluster ARN.
", + "smithy.api#jsonName": "arn" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The VPC ID to which the EKS cluster is attached.
", + "smithy.api#jsonName": "vpcId" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EKS cluster status.
", + "smithy.api#jsonName": "status" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The EKS cluster tags.
", + "smithy.api#jsonName": "tags" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the EKS cluster was created.
", + "smithy.api#jsonName": "createdAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#Email": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Designates an Amazon Web Services account within the organization as your GuardDuty delegated\n administrator. Only the organization's management account can run this \n API operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/admin/enable", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AdminAccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated\n administrator.
", + "smithy.api#jsonName": "adminAccountId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#EnableOrganizationAdminAccountResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#Eq": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Equals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Evidence": { + "type": "structure", + "members": { + "ThreatIntelligenceDetails": { + "target": "com.amazonaws.guardduty#ThreatIntelligenceDetails", + "traits": { + "smithy.api#documentation": "A list of threat intelligence details related to the evidence.
", + "smithy.api#jsonName": "threatIntelligenceDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the reason that the finding was generated.
" + } + }, + "com.amazonaws.guardduty#FargateDetails": { + "type": "structure", + "members": { + "Issues": { + "target": "com.amazonaws.guardduty#Issues", + "traits": { + "smithy.api#documentation": "Runtime coverage issues identified for the resource running on Amazon Web Services Fargate.
", + "smithy.api#jsonName": "issues" + } + }, + "ManagementType": { + "target": "com.amazonaws.guardduty#ManagementType", + "traits": { + "smithy.api#documentation": "Indicates how the GuardDuty security agent is managed for this resource.
\n\n AUTO_MANAGED indicates that GuardDuty deploys and manages updates for this resource.
\n DISABLED indicates that the deployment of the GuardDuty security agent is disabled for this resource.
The MANUAL status doesn't apply to the Amazon Web Services Fargate (Amazon ECS only) woprkloads.
Contains information about Amazon Web Services Fargate details associated with \n an Amazon ECS cluster.
" + } + }, + "com.amazonaws.guardduty#FeatureAdditionalConfiguration": { + "type": "enum", + "members": { + "EKS_ADDON_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_ADDON_MANAGEMENT" + } + }, + "ECS_FARGATE_AGENT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_FARGATE_AGENT_MANAGEMENT" + } + } + } + }, + "com.amazonaws.guardduty#FeatureStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.guardduty#Feedback": { + "type": "enum", + "members": { + "USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USEFUL" + } + }, + "NOT_USEFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_USEFUL" + } + } + } + }, + "com.amazonaws.guardduty#FilePaths": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanFilePath" + } + }, + "com.amazonaws.guardduty#FilterAction": { + "type": "enum", + "members": { + "NOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOOP" + } + }, + "ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARCHIVE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#FilterCondition": { + "type": "structure", + "members": { + "EqualsValue": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Represents an equal\n condition to be applied to\n a single field when querying for scan entries.
", + "smithy.api#jsonName": "equalsValue" + } + }, + "GreaterThan": { + "target": "com.amazonaws.guardduty#LongValue", + "traits": { + "smithy.api#documentation": "Represents a greater than condition to be applied to a single field\n when querying for scan entries.
", + "smithy.api#jsonName": "greaterThan" + } + }, + "LessThan": { + "target": "com.amazonaws.guardduty#LongValue", + "traits": { + "smithy.api#documentation": "Represents a less than condition to be applied to a single field when\n querying for scan entries.
", + "smithy.api#jsonName": "lessThan" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the condition.
" + } + }, + "com.amazonaws.guardduty#FilterCriteria": { + "type": "structure", + "members": { + "FilterCriterion": { + "target": "com.amazonaws.guardduty#FilterCriterionList", + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the\n operation.
", + "smithy.api#jsonName": "filterCriterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for describing scan entries.
" + } + }, + "com.amazonaws.guardduty#FilterCriterion": { + "type": "structure", + "members": { + "CriterionKey": { + "target": "com.amazonaws.guardduty#CriterionKey", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan properties to match with given scan\n entries.
\nReplace the enum value CLUSTER_NAME with EKS_CLUSTER_NAME.\n CLUSTER_NAME has been deprecated.
Contains information about the condition.
", + "smithy.api#jsonName": "filterCondition" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a condition that when matched will be added to the response of the operation.\n Irrespective of using any filter criteria, an administrator account can view the scan entries\n for all of its member accounts. However, each member account can view the scan entries only\n for their own account.
" + } + }, + "com.amazonaws.guardduty#FilterCriterionList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FilterCriterion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.guardduty#FilterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.guardduty#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + } + } + }, + "com.amazonaws.guardduty#FilterNames": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FilterName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#FilterRank": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.guardduty#Finding": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the account in which the finding was generated.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ARN of the finding.
", + "smithy.api#jsonName": "arn", + "smithy.api#required": {} + } + }, + "Confidence": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The confidence score for the finding.
", + "smithy.api#jsonName": "confidence" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time and date when the finding was created.
", + "smithy.api#jsonName": "createdAt", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The description of the finding.
", + "smithy.api#jsonName": "description" + } + }, + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the finding.
", + "smithy.api#jsonName": "id", + "smithy.api#required": {} + } + }, + "Partition": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The partition associated with the finding.
", + "smithy.api#jsonName": "partition" + } + }, + "Region": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Region where the finding was generated.
", + "smithy.api#jsonName": "region", + "smithy.api#required": {} + } + }, + "Resource": { + "target": "com.amazonaws.guardduty#Resource", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#jsonName": "resource", + "smithy.api#required": {} + } + }, + "SchemaVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The version of the schema used for the finding.
", + "smithy.api#jsonName": "schemaVersion", + "smithy.api#required": {} + } + }, + "Service": { + "target": "com.amazonaws.guardduty#Service", + "traits": { + "smithy.api#jsonName": "service" + } + }, + "Severity": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The severity of the finding.
", + "smithy.api#jsonName": "severity", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The title of the finding.
", + "smithy.api#jsonName": "title" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#FindingType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of finding.
", + "smithy.api#jsonName": "type", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The time and date when the finding was last updated.
", + "smithy.api#jsonName": "updatedAt", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the finding that is generated when abnormal or suspicious\n activity is detected.
" + } + }, + "com.amazonaws.guardduty#FindingCriteria": { + "type": "structure", + "members": { + "Criterion": { + "target": "com.amazonaws.guardduty#Criterion", + "traits": { + "smithy.api#documentation": "Represents a map of finding properties that match specified conditions and values when\n querying findings.
", + "smithy.api#jsonName": "criterion" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the criteria used for querying findings.
" + } + }, + "com.amazonaws.guardduty#FindingId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#FindingIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FindingId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#FindingPublishingFrequency": { + "type": "enum", + "members": { + "FIFTEEN_MINUTES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIFTEEN_MINUTES" + } + }, + "ONE_HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_HOUR" + } + }, + "SIX_HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIX_HOURS" + } + } + } + }, + "com.amazonaws.guardduty#FindingStatisticType": { + "type": "enum", + "members": { + "COUNT_BY_SEVERITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_BY_SEVERITY" + } + } + } + }, + "com.amazonaws.guardduty#FindingStatisticTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FindingStatisticType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.guardduty#FindingStatistics": { + "type": "structure", + "members": { + "CountBySeverity": { + "target": "com.amazonaws.guardduty#CountBySeverity", + "traits": { + "smithy.api#documentation": "Represents a map of severity to count statistics for a set of findings.
", + "smithy.api#jsonName": "countBySeverity" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about finding statistics.
" + } + }, + "com.amazonaws.guardduty#FindingType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#FindingTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FindingType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#Findings": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Finding" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#FlagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#FlowLogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Denotes whether VPC flow logs is enabled as a data source.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the status of VPC flow logs as a data source.
" + } + }, + "com.amazonaws.guardduty#FreeTrialFeatureConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FreeTrialFeatureResult", + "traits": { + "smithy.api#documentation": "The name of the feature for which the free trial is configured.
", + "smithy.api#jsonName": "name" + } + }, + "FreeTrialDaysRemaining": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of the remaining free trial days for the feature.
", + "smithy.api#jsonName": "freeTrialDaysRemaining" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the free trial period for a feature.
" + } + }, + "com.amazonaws.guardduty#FreeTrialFeatureConfigurationsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#FreeTrialFeatureConfigurationResult" + } + }, + "com.amazonaws.guardduty#FreeTrialFeatureResult": { + "type": "enum", + "members": { + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "FARGATE_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE_RUNTIME_MONITORING" + } + }, + "EC2_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_RUNTIME_MONITORING" + } + } + } + }, + "com.amazonaws.guardduty#GeoLocation": { + "type": "structure", + "members": { + "Lat": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The latitude information of the remote IP address.
", + "smithy.api#jsonName": "lat" + } + }, + "Lon": { + "target": "com.amazonaws.guardduty#Double", + "traits": { + "smithy.api#documentation": "The longitude information of the remote IP address.
", + "smithy.api#jsonName": "lon" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the location of the remote IP address.
" + } + }, + "com.amazonaws.guardduty#GetAdministratorAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetAdministratorAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetAdministratorAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Provides the details of the GuardDuty administrator account associated with the current\n GuardDuty member account.
\nIf the organization's management account or a delegated administrator runs this API, \n it will return success (HTTP 200) but no content.
The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetAdministratorAccountResponse": { + "type": "structure", + "members": { + "Administrator": { + "target": "com.amazonaws.guardduty#Administrator", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The administrator account details.
", + "smithy.api#jsonName": "administrator", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetCoverageStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetCoverageStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetCoverageStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves aggregated statistics for your account. If you are a GuardDuty administrator, you\n can retrieve the statistics for all the resources associated with the active member accounts\n in your organization who have enabled Runtime Monitoring and have the GuardDuty security agent running\n on their resources.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/coverage/statistics", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetCoverageStatisticsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the GuardDuty detector associated to the coverage statistics.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FilterCriteria": { + "target": "com.amazonaws.guardduty#CoverageFilterCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used to filter the coverage statistics
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "StatisticsType": { + "target": "com.amazonaws.guardduty#CoverageStatisticsTypeList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the statistics type used to aggregate the coverage details.
", + "smithy.api#jsonName": "statisticsType", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetCoverageStatisticsResponse": { + "type": "structure", + "members": { + "CoverageStatistics": { + "target": "com.amazonaws.guardduty#CoverageStatistics", + "traits": { + "smithy.api#documentation": "Represents the count aggregated by the statusCode and\n resourceType.
Retrieves an Amazon GuardDuty detector specified by the detectorId.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetDetectorRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetDetectorResponse": { + "type": "structure", + "members": { + "CreatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp of when the detector was created.
", + "smithy.api#jsonName": "createdAt" + } + }, + "FindingPublishingFrequency": { + "target": "com.amazonaws.guardduty#FindingPublishingFrequency", + "traits": { + "smithy.api#documentation": "The publishing frequency of the finding.
", + "smithy.api#jsonName": "findingPublishingFrequency" + } + }, + "ServiceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The GuardDuty service role.
", + "smithy.api#jsonName": "serviceRole", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#DetectorStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The detector status.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The last-updated timestamp for the detector.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources are enabled for the detector.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the detector resource.
", + "smithy.api#jsonName": "tags" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfigurationsResults", + "traits": { + "smithy.api#documentation": "Describes the features that have been enabled for the detector.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetFilterRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details of the filter specified by the filter name.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/filter/{FilterName}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the filter is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FilterName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the filter you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "filterName", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetFilterResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the filter.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#FilterDescription", + "traits": { + "smithy.api#documentation": "The description of the filter.
", + "smithy.api#jsonName": "description" + } + }, + "Action": { + "target": "com.amazonaws.guardduty#FilterAction", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Specifies the action that is to be applied to the findings that match the filter.
", + "smithy.api#jsonName": "action", + "smithy.api#required": {} + } + }, + "Rank": { + "target": "com.amazonaws.guardduty#FilterRank", + "traits": { + "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.
", + "smithy.api#jsonName": "rank" + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings.
", + "smithy.api#jsonName": "findingCriteria", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the filter resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Describes Amazon GuardDuty findings specified by finding IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings/get", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetFindingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to\n retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the findings that you want to retrieve.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#SortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used for sorting findings.
", + "smithy.api#jsonName": "sortCriteria" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetFindingsResponse": { + "type": "structure", + "members": { + "Findings": { + "target": "com.amazonaws.guardduty#Findings", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of findings.
", + "smithy.api#jsonName": "findings", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetFindingsStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetFindingsStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetFindingsStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Amazon GuardDuty findings statistics for the specified detector ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings/statistics", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetFindingsStatisticsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings' statistics you\n want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FindingStatisticTypes": { + "target": "com.amazonaws.guardduty#FindingStatisticTypes", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The types of finding statistics to retrieve.
", + "smithy.api#jsonName": "findingStatisticTypes", + "smithy.api#required": {} + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria that is used for querying findings.
", + "smithy.api#jsonName": "findingCriteria" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetFindingsStatisticsResponse": { + "type": "structure", + "members": { + "FindingStatistics": { + "target": "com.amazonaws.guardduty#FindingStatistics", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The finding statistics object.
", + "smithy.api#jsonName": "findingStatistics", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetIPSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the IPSet specified by the ipSetId.
The unique ID of the detector that the IPSet is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "IpSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the IPSet to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "ipSetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetIPSetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The user-friendly name for the IPSet.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#IpSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the file that contains the IPSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the IPSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#IpSetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of IPSet file that was uploaded.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the IPSet resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetInvitationsCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetInvitationsCountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetInvitationsCountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the count of all GuardDuty membership invitations that were sent to the current\n member account except the currently accepted invitation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/invitation/count", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetInvitationsCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetInvitationsCountResponse": { + "type": "structure", + "members": { + "InvitationsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The number of received invitations.
", + "smithy.api#jsonName": "invitationsCount" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMalwareScanSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMalwareScanSettingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMalwareScanSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the details of the malware scan settings.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/malware-scan-settings", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMalwareScanSettingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the scan setting is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMalwareScanSettingsResponse": { + "type": "structure", + "members": { + "ScanResourceCriteria": { + "target": "com.amazonaws.guardduty#ScanResourceCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for scanning resources.
", + "smithy.api#jsonName": "scanResourceCriteria" + } + }, + "EbsSnapshotPreservation": { + "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", + "traits": { + "smithy.api#documentation": "An enum value representing possible snapshot preservation settings.
", + "smithy.api#jsonName": "ebsSnapshotPreservation" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMasterAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMasterAccountRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMasterAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#deprecated": { + "message": "This operation is deprecated, use GetAdministratorAccount instead" + }, + "smithy.api#documentation": "Provides the details for the GuardDuty administrator account associated with the current\n GuardDuty member account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/master", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMasterAccountRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This input is deprecated, use GetAdministratorAccountRequest instead" + }, + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMasterAccountResponse": { + "type": "structure", + "members": { + "Master": { + "target": "com.amazonaws.guardduty#Master", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The administrator account details.
", + "smithy.api#jsonName": "master", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#deprecated": { + "message": "This output is deprecated, use GetAdministratorAccountResponse instead" + }, + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMemberDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMemberDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMemberDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Describes which data sources are enabled for the member account's detector.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/detector/get", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMemberDetectorsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID for the administrator account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The account ID of the member account.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMemberDetectorsResponse": { + "type": "structure", + "members": { + "MemberDataSourceConfigurations": { + "target": "com.amazonaws.guardduty#MemberDataSourceConfigurations", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "An object that describes which data sources are enabled for a member account.
", + "smithy.api#jsonName": "members", + "smithy.api#required": {} + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of member account IDs that were unable to be processed along with an explanation\n for why they were not processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves GuardDuty member accounts (of the current GuardDuty administrator account)\n specified by the account IDs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/get", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account whose members you want to\n retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts that you want to describe.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetMembersResponse": { + "type": "structure", + "members": { + "Members": { + "target": "com.amazonaws.guardduty#Members", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of members.
", + "smithy.api#jsonName": "members", + "smithy.api#required": {} + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetOrganizationStatistics": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.guardduty#GetOrganizationStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves how many active member accounts \n in your Amazon Web Services organization have\n each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.
\nWhen you create a new Amazon Web Services organization, it might take up to 24 \n hours to generate the statistics for the entire organization.
", + "smithy.api#http": { + "method": "GET", + "uri": "/organization/statistics", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetOrganizationStatisticsResponse": { + "type": "structure", + "members": { + "OrganizationDetails": { + "target": "com.amazonaws.guardduty#OrganizationDetails", + "traits": { + "smithy.api#documentation": "Information about the statistics report for your organization.
", + "smithy.api#jsonName": "organizationDetails" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDays": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Provides the number of days left for each data source used in the free trial\n period.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/freeTrial/daysRemaining", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty member account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "A list of account identifiers of the GuardDuty member account.
", + "smithy.api#jsonName": "accountIds" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetRemainingFreeTrialDaysResponse": { + "type": "structure", + "members": { + "Accounts": { + "target": "com.amazonaws.guardduty#AccountFreeTrialInfos", + "traits": { + "smithy.api#documentation": "The member accounts which were included in a request and were processed\n successfully.
", + "smithy.api#jsonName": "accounts" + } + }, + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#documentation": "The member account that was included in a request but for which the request could not be\n processed.
", + "smithy.api#jsonName": "unprocessedAccounts" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetThreatIntelSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetThreatIntelSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetThreatIntelSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#GetThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the threatIntelSet is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "ThreatIntelSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the threatIntelSet that you want to get.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "threatIntelSetId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetThreatIntelSetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A user-friendly ThreatIntelSet name displayed in all findings that are generated by\n activity that involves IP addresses included in this ThreatIntelSet.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.guardduty#ThreatIntelSetFormat", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The format of the threatIntelSet.
", + "smithy.api#jsonName": "format", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The URI of the file that contains the ThreatIntelSet.
", + "smithy.api#jsonName": "location", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.guardduty#ThreatIntelSetStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of threatIntelSet file uploaded.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags of the threat list resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#GetUsageStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#GetUsageStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#GetUsageStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Amazon GuardDuty usage statistics over the last 30 days for the specified detector\n ID. For newly enabled detectors or data sources, the cost returned will include only the usage\n so far under 30 days. This may differ from the cost metrics in the console, which project\n usage over 30 days to provide a monthly cost estimate. For more information, see Understanding How Usage Costs are Calculated.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/usage/statistics", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#GetUsageStatisticsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose usage statistics you\n want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "UsageStatisticType": { + "target": "com.amazonaws.guardduty#UsageStatisticType", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The type of usage statistics to retrieve.
", + "smithy.api#jsonName": "usageStatisticsType", + "smithy.api#required": {} + } + }, + "UsageCriteria": { + "target": "com.amazonaws.guardduty#UsageCriteria", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the criteria used for querying usage.
", + "smithy.api#jsonName": "usageCriteria", + "smithy.api#required": {} + } + }, + "Unit": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The currency unit you would like to view your usage statistics in. Current valid values\n are USD.
", + "smithy.api#jsonName": "unit" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results after the first\n page.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#GetUsageStatisticsResponse": { + "type": "structure", + "members": { + "UsageStatistics": { + "target": "com.amazonaws.guardduty#UsageStatistics", + "traits": { + "smithy.api#documentation": "The usage statistics object. If a UsageStatisticType was provided, the objects\n representing other types will be null.
", + "smithy.api#jsonName": "usageStatistics" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#Groups": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#GuardDutyAPIService": { + "type": "service", + "version": "2017-11-28", + "operations": [ + { + "target": "com.amazonaws.guardduty#AcceptAdministratorInvitation" + }, + { + "target": "com.amazonaws.guardduty#AcceptInvitation" + }, + { + "target": "com.amazonaws.guardduty#ArchiveFindings" + }, + { + "target": "com.amazonaws.guardduty#CreateDetector" + }, + { + "target": "com.amazonaws.guardduty#CreateFilter" + }, + { + "target": "com.amazonaws.guardduty#CreateIPSet" + }, + { + "target": "com.amazonaws.guardduty#CreateMembers" + }, + { + "target": "com.amazonaws.guardduty#CreatePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#CreateSampleFindings" + }, + { + "target": "com.amazonaws.guardduty#CreateThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#DeclineInvitations" + }, + { + "target": "com.amazonaws.guardduty#DeleteDetector" + }, + { + "target": "com.amazonaws.guardduty#DeleteFilter" + }, + { + "target": "com.amazonaws.guardduty#DeleteInvitations" + }, + { + "target": "com.amazonaws.guardduty#DeleteIPSet" + }, + { + "target": "com.amazonaws.guardduty#DeleteMembers" + }, + { + "target": "com.amazonaws.guardduty#DeletePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#DeleteThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#DescribeMalwareScans" + }, + { + "target": "com.amazonaws.guardduty#DescribeOrganizationConfiguration" + }, + { + "target": "com.amazonaws.guardduty#DescribePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#DisableOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.guardduty#DisassociateFromAdministratorAccount" + }, + { + "target": "com.amazonaws.guardduty#DisassociateFromMasterAccount" + }, + { + "target": "com.amazonaws.guardduty#DisassociateMembers" + }, + { + "target": "com.amazonaws.guardduty#EnableOrganizationAdminAccount" + }, + { + "target": "com.amazonaws.guardduty#GetAdministratorAccount" + }, + { + "target": "com.amazonaws.guardduty#GetCoverageStatistics" + }, + { + "target": "com.amazonaws.guardduty#GetDetector" + }, + { + "target": "com.amazonaws.guardduty#GetFilter" + }, + { + "target": "com.amazonaws.guardduty#GetFindings" + }, + { + "target": "com.amazonaws.guardduty#GetFindingsStatistics" + }, + { + "target": "com.amazonaws.guardduty#GetInvitationsCount" + }, + { + "target": "com.amazonaws.guardduty#GetIPSet" + }, + { + "target": "com.amazonaws.guardduty#GetMalwareScanSettings" + }, + { + "target": "com.amazonaws.guardduty#GetMasterAccount" + }, + { + "target": "com.amazonaws.guardduty#GetMemberDetectors" + }, + { + "target": "com.amazonaws.guardduty#GetMembers" + }, + { + "target": "com.amazonaws.guardduty#GetOrganizationStatistics" + }, + { + "target": "com.amazonaws.guardduty#GetRemainingFreeTrialDays" + }, + { + "target": "com.amazonaws.guardduty#GetThreatIntelSet" + }, + { + "target": "com.amazonaws.guardduty#GetUsageStatistics" + }, + { + "target": "com.amazonaws.guardduty#InviteMembers" + }, + { + "target": "com.amazonaws.guardduty#ListCoverage" + }, + { + "target": "com.amazonaws.guardduty#ListDetectors" + }, + { + "target": "com.amazonaws.guardduty#ListFilters" + }, + { + "target": "com.amazonaws.guardduty#ListFindings" + }, + { + "target": "com.amazonaws.guardduty#ListInvitations" + }, + { + "target": "com.amazonaws.guardduty#ListIPSets" + }, + { + "target": "com.amazonaws.guardduty#ListMembers" + }, + { + "target": "com.amazonaws.guardduty#ListOrganizationAdminAccounts" + }, + { + "target": "com.amazonaws.guardduty#ListPublishingDestinations" + }, + { + "target": "com.amazonaws.guardduty#ListTagsForResource" + }, + { + "target": "com.amazonaws.guardduty#ListThreatIntelSets" + }, + { + "target": "com.amazonaws.guardduty#StartMalwareScan" + }, + { + "target": "com.amazonaws.guardduty#StartMonitoringMembers" + }, + { + "target": "com.amazonaws.guardduty#StopMonitoringMembers" + }, + { + "target": "com.amazonaws.guardduty#TagResource" + }, + { + "target": "com.amazonaws.guardduty#UnarchiveFindings" + }, + { + "target": "com.amazonaws.guardduty#UntagResource" + }, + { + "target": "com.amazonaws.guardduty#UpdateDetector" + }, + { + "target": "com.amazonaws.guardduty#UpdateFilter" + }, + { + "target": "com.amazonaws.guardduty#UpdateFindingsFeedback" + }, + { + "target": "com.amazonaws.guardduty#UpdateIPSet" + }, + { + "target": "com.amazonaws.guardduty#UpdateMalwareScanSettings" + }, + { + "target": "com.amazonaws.guardduty#UpdateMemberDetectors" + }, + { + "target": "com.amazonaws.guardduty#UpdateOrganizationConfiguration" + }, + { + "target": "com.amazonaws.guardduty#UpdatePublishingDestination" + }, + { + "target": "com.amazonaws.guardduty#UpdateThreatIntelSet" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "GuardDuty", + "arnNamespace": "guardduty", + "cloudFormationName": "GuardDuty", + "cloudTrailEventSource": "guardduty.amazonaws.com", + "endpointPrefix": "guardduty" + }, + "aws.auth#sigv4": { + "name": "guardduty" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon GuardDuty is a continuous security monitoring service that analyzes and processes\n the following foundational data sources - VPC flow logs, Amazon Web Services CloudTrail management event logs, CloudTrail S3 data event\n logs, EKS audit logs, DNS logs, Amazon EBS volume data, runtime activity belonging to container workloads, such \n as Amazon EKS, Amazon ECS (including Amazon Web Services Fargate), and Amazon EC2 instances.\n It uses threat intelligence\n feeds, such as lists of malicious IPs and domains, and machine learning to identify\n unexpected, potentially unauthorized, and malicious activity within your Amazon Web Services environment.\n This can include issues like escalations of privileges, uses of exposed credentials, or\n communication with malicious IPs, domains, or presence of malware on your Amazon EC2 instances\n and container workloads. For example, GuardDuty can detect compromised EC2 instances and\n container workloads serving malware, or mining bitcoin.
\nGuardDuty also monitors Amazon Web Services account access behavior for signs of compromise, such as\n unauthorized infrastructure deployments like EC2 instances deployed in a Region that has never\n been used, or unusual API calls like a password policy change to reduce password strength.
\nGuardDuty informs you about the status of your Amazon Web Services environment by producing security\n findings that you can view in the GuardDuty console or through Amazon EventBridge. For more\n information, see the \n Amazon\n GuardDuty User Guide\n .
", + "smithy.api#title": "Amazon GuardDuty", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://guardduty-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + }, + "aws-us-gov" + ] + } + ], + "endpoint": { + "url": "https://guardduty.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://guardduty-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://guardduty.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://guardduty.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ap-southeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-north-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.eu-west-3.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-3", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.me-south-1.amazonaws.com" + } + }, + "params": { + "Region": "me-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://guardduty.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.guardduty#GuardDutyArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[A-Za-z_.-]{1,20}:guardduty:[A-Za-z0-9_/.-]{0,63}:\\d+:detector/[A-Za-z0-9_/.-]{32,264}$" + } + }, + "com.amazonaws.guardduty#HighestSeverityThreatDetails": { + "type": "structure", + "members": { + "Severity": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Severity level of the highest severity threat detected.
", + "smithy.api#jsonName": "severity" + } + }, + "ThreatName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Threat name of the highest severity threat detected as part of the malware scan.
", + "smithy.api#jsonName": "threatName" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files with the highest severity threat detected.
", + "smithy.api#jsonName": "count" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of the highest severity threat detected during scan and number of\n infected files.
" + } + }, + "com.amazonaws.guardduty#HostPath": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Path of the file or directory on the host that the volume maps to.
", + "smithy.api#jsonName": "path" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a pre-existing file or directory on the host machine that the volume maps\n to.
" + } + }, + "com.amazonaws.guardduty#IamInstanceProfile": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The profile ARN of the EC2 instance.
", + "smithy.api#jsonName": "arn" + } + }, + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The profile ID of the EC2 instance.
", + "smithy.api#jsonName": "id" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the EC2 instance profile.
" + } + }, + "com.amazonaws.guardduty#ImpersonatedUser": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Information about the username that was being impersonated.
The group to which the user name belongs.
Contains information about the impersonated user.
" + } + }, + "com.amazonaws.guardduty#InstanceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-z]+:[a-z]+(-[0-9]+|-[a-z]+)+:([0-9]{12}):[a-z\\-]+\\/[a-zA-Z0-9]*$" + } + }, + "com.amazonaws.guardduty#InstanceDetails": { + "type": "structure", + "members": { + "AvailabilityZone": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Availability Zone of the EC2 instance.
", + "smithy.api#jsonName": "availabilityZone" + } + }, + "IamInstanceProfile": { + "target": "com.amazonaws.guardduty#IamInstanceProfile", + "traits": { + "smithy.api#documentation": "The profile information of the EC2 instance.
", + "smithy.api#jsonName": "iamInstanceProfile" + } + }, + "ImageDescription": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The image description of the EC2 instance.
", + "smithy.api#jsonName": "imageDescription" + } + }, + "ImageId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The image ID of the EC2 instance.
", + "smithy.api#jsonName": "imageId" + } + }, + "InstanceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the EC2 instance.
", + "smithy.api#jsonName": "instanceId" + } + }, + "InstanceState": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The state of the EC2 instance.
", + "smithy.api#jsonName": "instanceState" + } + }, + "InstanceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of the EC2 instance.
", + "smithy.api#jsonName": "instanceType" + } + }, + "OutpostArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost. Only applicable to Amazon Web Services Outposts\n instances.
", + "smithy.api#jsonName": "outpostArn" + } + }, + "LaunchTime": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The launch time of the EC2 instance.
", + "smithy.api#jsonName": "launchTime" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.guardduty#NetworkInterfaces", + "traits": { + "smithy.api#documentation": "The elastic network interface information of the EC2 instance.
", + "smithy.api#jsonName": "networkInterfaces" + } + }, + "Platform": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The platform of the EC2 instance.
", + "smithy.api#jsonName": "platform" + } + }, + "ProductCodes": { + "target": "com.amazonaws.guardduty#ProductCodes", + "traits": { + "smithy.api#documentation": "The product code of the EC2 instance.
", + "smithy.api#jsonName": "productCodes" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "The tags of the EC2 instance.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the details of an instance.
" + } + }, + "com.amazonaws.guardduty#Integer": { + "type": "integer" + }, + "com.amazonaws.guardduty#IntegerValueWithMax": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error message.
", + "smithy.api#jsonName": "message" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The error type.
", + "smithy.api#jsonName": "__type" + } + } + }, + "traits": { + "smithy.api#documentation": "An internal server error exception object.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.guardduty#Invitation": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the account that the invitation was sent from.
", + "smithy.api#jsonName": "accountId" + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the invitation. This value is used to validate the inviter account to the member\n account.
", + "smithy.api#jsonName": "invitationId" + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the relationship between the inviter and invitee accounts.
", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the invitation to become a member account.
" + } + }, + "com.amazonaws.guardduty#Invitations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Invitation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#InviteMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#InviteMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#InviteMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not\n needed. For more information, see Managing accounts with organizations.
\nTo invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/invite", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#InviteMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to invite members\n with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the accounts that you want to invite to GuardDuty as\n members.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + }, + "DisableEmailNotification": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "A Boolean value that specifies whether you want to disable email notification to the\n accounts that you are inviting to GuardDuty as members.
", + "smithy.api#jsonName": "disableEmailNotification" + } + }, + "Message": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The invitation message that you want to send to the accounts that you're inviting to\n GuardDuty as members.
", + "smithy.api#jsonName": "message" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#InviteMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#IpSetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#IpSetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#IpSetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#Ipv6Addresses": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Issues": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#KubernetesApiCallAction": { + "type": "structure", + "members": { + "RequestUri": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Kubernetes API request URI.
", + "smithy.api#jsonName": "requestUri" + } + }, + "Verb": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Kubernetes API request HTTP verb.
", + "smithy.api#jsonName": "verb" + } + }, + "SourceIps": { + "target": "com.amazonaws.guardduty#SourceIps", + "traits": { + "smithy.api#documentation": "The IP of the Kubernetes API caller and the IPs of any proxies or load balancers between\n the caller and the API endpoint.
", + "smithy.api#jsonName": "sourceIps" + } + }, + "UserAgent": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The user agent of the caller of the Kubernetes API.
", + "smithy.api#jsonName": "userAgent" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#jsonName": "remoteIpDetails" + } + }, + "StatusCode": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The resulting HTTP response code of the Kubernetes API call action.
", + "smithy.api#jsonName": "statusCode" + } + }, + "Parameters": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Parameters related to the Kubernetes API call action.
", + "smithy.api#jsonName": "parameters" + } + }, + "Resource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The resource component in the Kubernetes API call action.
", + "smithy.api#jsonName": "resource" + } + }, + "Subresource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the sub-resource in the Kubernetes API call action.
", + "smithy.api#jsonName": "subresource" + } + }, + "Namespace": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the namespace where the Kubernetes API call action takes place.
", + "smithy.api#jsonName": "namespace" + } + }, + "ResourceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the resource in the Kubernetes API call action.
", + "smithy.api#jsonName": "resourceName" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Kubernetes API call action described in this finding.
" + } + }, + "com.amazonaws.guardduty#KubernetesAuditLogsConfiguration": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of Kubernetes audit logs as a data source.
", + "smithy.api#jsonName": "enable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#KubernetesAuditLogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that describes whether Kubernetes audit logs are enabled as a data source.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#KubernetesConfiguration": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#KubernetesAuditLogsConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of Kubernetes audit logs as a data source.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes data sources are enabled.
" + } + }, + "com.amazonaws.guardduty#KubernetesConfigurationResult": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#KubernetesAuditLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether any Kubernetes logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
", + "smithy.api#jsonName": "auditLogs" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about the Kubernetes resources when it is enabled as a data\n source.
" + } + }, + "com.amazonaws.guardduty#KubernetesDetails": { + "type": "structure", + "members": { + "KubernetesUserDetails": { + "target": "com.amazonaws.guardduty#KubernetesUserDetails", + "traits": { + "smithy.api#documentation": "Details about the Kubernetes user involved in a Kubernetes finding.
", + "smithy.api#jsonName": "kubernetesUserDetails" + } + }, + "KubernetesWorkloadDetails": { + "target": "com.amazonaws.guardduty#KubernetesWorkloadDetails", + "traits": { + "smithy.api#documentation": "Details about the Kubernetes workload involved in a Kubernetes finding.
", + "smithy.api#jsonName": "kubernetesWorkloadDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about Kubernetes resources such as a Kubernetes user or workload resource involved\n in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#KubernetesPermissionCheckedDetails": { + "type": "structure", + "members": { + "Verb": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The verb component of the Kubernetes API call. For example, when you check whether or not you have the permission\n to call the CreatePod API, the verb component will be Create.
The Kubernetes resource with which your Kubernetes API call will interact.
", + "smithy.api#jsonName": "resource" + } + }, + "Namespace": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The namespace where the Kubernetes API action will take place.
", + "smithy.api#jsonName": "namespace" + } + }, + "Allowed": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Information whether the user has the permission to call the Kubernetes API.
", + "smithy.api#jsonName": "allowed" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Kubernetes API for which you check if you have permission to call.
" + } + }, + "com.amazonaws.guardduty#KubernetesRoleBindingDetails": { + "type": "structure", + "members": { + "Kind": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The kind of the role. For role binding, this value will be RoleBinding.
The name of the RoleBinding.
The unique identifier of the role binding.
", + "smithy.api#jsonName": "uid" + } + }, + "RoleRefName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the role being referenced. This must match the name of the Role\n or ClusterRole that you want to bind to.
The type of the role being referenced. This could be either Role or \n ClusterRole.
Contains information about the role binding that grants the permission defined in a Kubernetes role.
" + } + }, + "com.amazonaws.guardduty#KubernetesRoleDetails": { + "type": "structure", + "members": { + "Kind": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The kind of role. For this API, the value of kind will be Role.
The name of the Kubernetes role.
", + "smithy.api#jsonName": "name" + } + }, + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the Kubernetes role name.
", + "smithy.api#jsonName": "uid" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Kubernetes role name and role type.
" + } + }, + "com.amazonaws.guardduty#KubernetesUserDetails": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The username of the user who called the Kubernetes API.
", + "smithy.api#jsonName": "username" + } + }, + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The user ID of the user who called the Kubernetes API.
", + "smithy.api#jsonName": "uid" + } + }, + "Groups": { + "target": "com.amazonaws.guardduty#Groups", + "traits": { + "smithy.api#documentation": "The groups that include the user who called the Kubernetes API.
", + "smithy.api#jsonName": "groups" + } + }, + "SessionName": { + "target": "com.amazonaws.guardduty#SessionNameList", + "traits": { + "smithy.api#documentation": "Entity that assumes the IAM role \n when Kubernetes RBAC permissions are assigned to that role.
", + "smithy.api#jsonName": "sessionName" + } + }, + "ImpersonatedUser": { + "target": "com.amazonaws.guardduty#ImpersonatedUser", + "traits": { + "smithy.api#documentation": "Information about the impersonated user.
", + "smithy.api#jsonName": "impersonatedUser" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the Kubernetes user involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#KubernetesWorkloadDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes workload name.
", + "smithy.api#jsonName": "name" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes workload type (e.g. Pod, Deployment, etc.).
", + "smithy.api#jsonName": "type" + } + }, + "Uid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes workload ID.
", + "smithy.api#jsonName": "uid" + } + }, + "Namespace": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Kubernetes namespace that the workload is part of.
", + "smithy.api#jsonName": "namespace" + } + }, + "HostNetwork": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the hostNetwork flag is enabled for the pods included in the workload.
", + "smithy.api#jsonName": "hostNetwork" + } + }, + "Containers": { + "target": "com.amazonaws.guardduty#Containers", + "traits": { + "smithy.api#documentation": "Containers running as part of the Kubernetes workload.
", + "smithy.api#jsonName": "containers" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Volumes", + "traits": { + "smithy.api#documentation": "Volumes used by the Kubernetes workload.
", + "smithy.api#jsonName": "volumes" + } + }, + "ServiceAccountName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The service account name that is associated with a Kubernetes workload.
", + "smithy.api#jsonName": "serviceAccountName" + } + }, + "HostIPC": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the host IPC flag is enabled for the pods in the workload.
", + "smithy.api#jsonName": "hostIPC" + } + }, + "HostPID": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the host PID flag is enabled for the pods in the workload.
", + "smithy.api#jsonName": "hostPID" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the Kubernetes workload involved in a Kubernetes finding.
" + } + }, + "com.amazonaws.guardduty#LambdaDetails": { + "type": "structure", + "members": { + "FunctionArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Amazon Resource Name (ARN) of the Lambda function.
", + "smithy.api#jsonName": "functionArn" + } + }, + "FunctionName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Name of the Lambda function.
", + "smithy.api#jsonName": "functionName" + } + }, + "Description": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Description of the Lambda function.
", + "smithy.api#jsonName": "description" + } + }, + "LastModifiedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the Lambda function was last modified. This field is in the UTC date string \n format (2023-03-22T19:37:20.168Z).
The revision ID of the Lambda function version.
", + "smithy.api#jsonName": "revisionId" + } + }, + "FunctionVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the Lambda function.
", + "smithy.api#jsonName": "functionVersion" + } + }, + "Role": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The execution role of the Lambda function.
", + "smithy.api#jsonName": "role" + } + }, + "VpcConfig": { + "target": "com.amazonaws.guardduty#VpcConfig", + "traits": { + "smithy.api#documentation": "Amazon Virtual Private Cloud configuration details associated with your Lambda function.
", + "smithy.api#jsonName": "vpcConfig" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "A list of tags attached to this resource, listed in the format of \n key:value pair.
Information about the Lambda function involved in the finding.
" + } + }, + "com.amazonaws.guardduty#Lineage": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#LineageObject" + } + }, + "com.amazonaws.guardduty#LineageObject": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the process started. This is in UTC format.
", + "smithy.api#jsonName": "startTime" + } + }, + "NamespacePid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The process ID of the child process.
", + "smithy.api#jsonName": "namespacePid" + } + }, + "UserId": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The user ID of the user that executed the process.
", + "smithy.api#jsonName": "userId" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the process.
", + "smithy.api#jsonName": "name" + } + }, + "Pid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The ID of the process.
", + "smithy.api#jsonName": "pid" + } + }, + "Uuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID assigned to the process by GuardDuty.
", + "smithy.api#jsonName": "uuid" + } + }, + "ExecutablePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The absolute path of the process executable file.
", + "smithy.api#jsonName": "executablePath" + } + }, + "Euid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The effective user ID that was used to execute the process.
", + "smithy.api#jsonName": "euid" + } + }, + "ParentUuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the parent process. This ID is assigned to the parent process by\n GuardDuty.
", + "smithy.api#jsonName": "parentUuid" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the runtime process details.
" + } + }, + "com.amazonaws.guardduty#ListCoverage": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListCoverageRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListCoverageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can\n retrieve all resources associated with the active member accounts in your organization.
\nMake sure the accounts have Runtime Monitoring enabled and GuardDuty agent running on\n their resources.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/coverage", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Resources", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListCoverageRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector whose coverage details you want to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results after the first\n page.
", + "smithy.api#jsonName": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#jsonName": "maxResults" + } + }, + "FilterCriteria": { + "target": "com.amazonaws.guardduty#CoverageFilterCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used to filter the coverage details.
", + "smithy.api#jsonName": "filterCriteria" + } + }, + "SortCriteria": { + "target": "com.amazonaws.guardduty#CoverageSortCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used to sort the coverage details.
", + "smithy.api#jsonName": "sortCriteria" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListCoverageResponse": { + "type": "structure", + "members": { + "Resources": { + "target": "com.amazonaws.guardduty#CoverageResources", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of resources and their attributes providing cluster details.
", + "smithy.api#jsonName": "resources", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists detectorIds of all the existing Amazon GuardDuty detector resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DetectorIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListDetectorsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListDetectorsResponse": { + "type": "structure", + "members": { + "DetectorIds": { + "target": "com.amazonaws.guardduty#DetectorIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of detector IDs.
", + "smithy.api#jsonName": "detectorIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListFiltersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListFiltersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of the current filters.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/filter", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FilterNames", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListFiltersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the filter is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListFiltersResponse": { + "type": "structure", + "members": { + "FilterNames": { + "target": "com.amazonaws.guardduty#FilterNames", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of filter names.
", + "smithy.api#jsonName": "filterNames", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists Amazon GuardDuty findings for the specified detector ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FindingIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListFindingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to\n list.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria used for querying findings. Valid values include:
\nJSON field name
\naccountId
\nregion
\nconfidence
\nid
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.resourceType
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.additionalInfo.threatListName
\nservice.archived
\nWhen this attribute is set to 'true', only archived findings are listed. When it's set\n to 'false', only unarchived findings are listed. When this attribute is not set, all\n existing findings are listed.
\nservice.resourceRole
\nseverity
\ntype
\nupdatedAt
\nType: Timestamp in Unix Epoch millisecond format: 1486685375000
\nRepresents the criteria used for sorting findings.
", + "smithy.api#jsonName": "sortCriteria" + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListFindingsResponse": { + "type": "structure", + "members": { + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the findings that you're listing.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListIPSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListIPSetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListIPSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this\n operation from a member account, the IPSets returned are the IPSets from the associated\n administrator account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/ipset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IpSetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListIPSetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the IPSet is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListIPSetsResponse": { + "type": "structure", + "members": { + "IpSetIds": { + "target": "com.amazonaws.guardduty#IpSetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the IPSet resources.
", + "smithy.api#jsonName": "ipSetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListInvitations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListInvitationsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListInvitationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services\n account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/invitation", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Invitations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListInvitationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListInvitationsResponse": { + "type": "structure", + "members": { + "Invitations": { + "target": "com.amazonaws.guardduty#Invitations", + "traits": { + "smithy.api#documentation": "A list of invitation descriptions.
", + "smithy.api#jsonName": "invitations" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists details about all member accounts for the current GuardDuty administrator\n account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/member", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Members", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector the member is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + }, + "OnlyAssociated": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Specifies whether to only return associated members or to return all members (including\n members who haven't been invited yet or have been disassociated). Member accounts must have\n been previously associated with the GuardDuty administrator account using \n Create\n Members\n .
A list of members.
\nThe values for email and invitedAt are available\n only if the member accounts are added by invitation.
The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListOrganizationAdminAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListOrganizationAdminAccountsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListOrganizationAdminAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the accounts designated as GuardDuty delegated administrators. \n Only the organization's management account can run this \n API operation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/admin", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AdminAccounts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListOrganizationAdminAccountsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.
A list of accounts configured as GuardDuty delegated administrators.
", + "smithy.api#jsonName": "adminAccounts" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListPublishingDestinations": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListPublishingDestinationsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListPublishingDestinationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of publishing destinations associated with the specified\n detectorId.
The ID of the detector to retrieve publishing destinations for.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in the response.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.
A Destinations object that includes information about each publishing\n destination returned.
A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.
Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. \n When invoked, this\n operation returns all assigned tags for a given resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#GuardDutyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the given GuardDuty resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "resourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#documentation": "The tags associated with the resource.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#ListThreatIntelSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#ListThreatIntelSetsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#ListThreatIntelSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you\n use this operation from a member account, the ThreatIntelSets associated with the\n administrator account are returned.
", + "smithy.api#http": { + "method": "GET", + "uri": "/detector/{DetectorId}/threatintelset", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThreatIntelSetIds", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.guardduty#ListThreatIntelSetsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the threatIntelSet is associated with.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.guardduty#MaxResults", + "traits": { + "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#jsonName": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "You can use this parameter to paginate results in the response. Set the value of this\n parameter to null on your first call to the list action. For subsequent calls to the action,\n fill nextToken in the request with the value of NextToken from the previous response to\n continue listing data.
", + "smithy.api#httpQuery": "nextToken", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#ListThreatIntelSetsResponse": { + "type": "structure", + "members": { + "ThreatIntelSetIds": { + "target": "com.amazonaws.guardduty#ThreatIntelSetIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the ThreatIntelSet resources.
", + "smithy.api#jsonName": "threatIntelSetIds", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#LocalIpDetails": { + "type": "structure", + "members": { + "IpAddressV4": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The IPv4 local address of the connection.
", + "smithy.api#jsonName": "ipAddressV4" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the local IP address of the connection.
" + } + }, + "com.amazonaws.guardduty#LocalPortDetails": { + "type": "structure", + "members": { + "Port": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The port number of the local connection.
", + "smithy.api#jsonName": "port" + } + }, + "PortName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The port name of the local connection.
", + "smithy.api#jsonName": "portName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the port for the local connection.
" + } + }, + "com.amazonaws.guardduty#Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#LoginAttribute": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Indicates the user name which attempted to log in.
", + "smithy.api#jsonName": "user" + } + }, + "Application": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Indicates the application name used to attempt log in.
", + "smithy.api#jsonName": "application" + } + }, + "FailedLoginAttempts": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Represents the sum of failed (unsuccessful) login attempts made to establish a connection\n to the database instance.
", + "smithy.api#jsonName": "failedLoginAttempts" + } + }, + "SuccessfulLoginAttempts": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Represents the sum of successful connections (a correct combination of login attributes)\n made to the database instance by the actor.
", + "smithy.api#jsonName": "successfulLoginAttempts" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the login attempts.
" + } + }, + "com.amazonaws.guardduty#LoginAttributes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#LoginAttribute" + } + }, + "com.amazonaws.guardduty#Long": { + "type": "long" + }, + "com.amazonaws.guardduty#LongValue": { + "type": "long" + }, + "com.amazonaws.guardduty#MalwareProtectionConfiguration": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindings", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionConfigurationResult": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + }, + "ServiceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The GuardDuty Malware Protection service role.
", + "smithy.api#jsonName": "serviceRole" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data\n sources.
" + } + }, + "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#DataSourceFreeTrial", + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings is enabled as a data\n source.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides details about Malware Protection when it is enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#ManagementType": { + "type": "enum", + "members": { + "AUTO_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_MANAGED" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.guardduty#MapEquals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanConditionPair" + } + }, + "com.amazonaws.guardduty#Master": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the account used as the administrator account.
", + "smithy.api#jsonName": "accountId" + } + }, + "InvitationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The value used to validate the administrator account to the member account.
", + "smithy.api#jsonName": "invitationId" + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The status of the relationship between the administrator and member accounts.
", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the administrator account and invitation.
" + } + }, + "com.amazonaws.guardduty#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#Member": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The ID of the member account.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID of the member account.
", + "smithy.api#jsonName": "detectorId" + } + }, + "MasterId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The administrator account ID.
", + "smithy.api#jsonName": "masterId", + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.guardduty#Email", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The email address of the member account.
", + "smithy.api#jsonName": "email", + "smithy.api#required": {} + } + }, + "RelationshipStatus": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of the relationship between the member and the administrator.
", + "smithy.api#jsonName": "relationshipStatus", + "smithy.api#required": {} + } + }, + "InvitedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The timestamp when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The last-updated timestamp of the member.
", + "smithy.api#jsonName": "updatedAt", + "smithy.api#required": {} + } + }, + "AdministratorId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The administrator account ID.
", + "smithy.api#jsonName": "administratorId" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the member account.
" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Status of the additional configuration.
", + "smithy.api#jsonName": "status" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Indicates the name of the additional configuration that is set for the member\n account.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the additional configuration that is set for the member\n account.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the additional configuration was set for the member account. This\n is in UTC format.
", + "smithy.api#jsonName": "updatedAt" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the additional configuration for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfigurationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfigurationResult" + } + }, + "com.amazonaws.guardduty#MemberAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#MemberDataSourceConfiguration": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The account ID for the member account.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Contains information on the status of data sources for the account.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfigurationsResults", + "traits": { + "smithy.api#documentation": "Contains information about the status of the features for the member account.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on which data sources are enabled for a member account.
" + } + }, + "com.amazonaws.guardduty#MemberDataSourceConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberDataSourceConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "The name of the feature.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "The status of the feature.
", + "smithy.api#jsonName": "status" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfigurations", + "traits": { + "smithy.api#documentation": "Additional configuration of the feature for the member account.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the features for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "Indicates the name of the feature that is enabled for the detector.
", + "smithy.api#jsonName": "name" + } + }, + "Status": { + "target": "com.amazonaws.guardduty#FeatureStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the feature that is enabled for the detector.
", + "smithy.api#jsonName": "status" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the feature object was updated.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#MemberAdditionalConfigurationResults", + "traits": { + "smithy.api#documentation": "Indicates the additional configuration of the feature that is configured for the member\n account.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the features for the member account.
" + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfiguration" + } + }, + "com.amazonaws.guardduty#MemberFeaturesConfigurationsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfigurationResult" + } + }, + "com.amazonaws.guardduty#Members": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Member" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#MemoryRegionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#Neq": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#NetworkConnectionAction": { + "type": "structure", + "members": { + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether EC2 blocked the network connection to your instance.
", + "smithy.api#jsonName": "blocked" + } + }, + "ConnectionDirection": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The network connection direction.
", + "smithy.api#jsonName": "connectionDirection" + } + }, + "LocalPortDetails": { + "target": "com.amazonaws.guardduty#LocalPortDetails", + "traits": { + "smithy.api#documentation": "The local port information of the connection.
", + "smithy.api#jsonName": "localPortDetails" + } + }, + "Protocol": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The network connection protocol.
", + "smithy.api#jsonName": "protocol" + } + }, + "LocalIpDetails": { + "target": "com.amazonaws.guardduty#LocalIpDetails", + "traits": { + "smithy.api#documentation": "The local IP information of the connection.
", + "smithy.api#jsonName": "localIpDetails" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#documentation": "The remote IP information of the connection.
", + "smithy.api#jsonName": "remoteIpDetails" + } + }, + "RemotePortDetails": { + "target": "com.amazonaws.guardduty#RemotePortDetails", + "traits": { + "smithy.api#documentation": "The remote port information of the connection.
", + "smithy.api#jsonName": "remotePortDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the NETWORK_CONNECTION action described in the finding.
" + } + }, + "com.amazonaws.guardduty#NetworkInterface": { + "type": "structure", + "members": { + "Ipv6Addresses": { + "target": "com.amazonaws.guardduty#Ipv6Addresses", + "traits": { + "smithy.api#documentation": "A list of IPv6 addresses for the EC2 instance.
", + "smithy.api#jsonName": "ipv6Addresses" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the network interface.
", + "smithy.api#jsonName": "networkInterfaceId" + } + }, + "PrivateDnsName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The private DNS name of the EC2 instance.
", + "smithy.api#jsonName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The private IP address of the EC2 instance.
", + "smithy.api#jsonName": "privateIpAddress" + } + }, + "PrivateIpAddresses": { + "target": "com.amazonaws.guardduty#PrivateIpAddresses", + "traits": { + "smithy.api#documentation": "Other private IP address information of the EC2 instance.
", + "smithy.api#jsonName": "privateIpAddresses" + } + }, + "PublicDnsName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The public DNS name of the EC2 instance.
", + "smithy.api#jsonName": "publicDnsName" + } + }, + "PublicIp": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The public IP address of the EC2 instance.
", + "smithy.api#jsonName": "publicIp" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.guardduty#SecurityGroups", + "traits": { + "smithy.api#documentation": "The security groups associated with the EC2 instance.
", + "smithy.api#jsonName": "securityGroups" + } + }, + "SubnetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The subnet ID of the EC2 instance.
", + "smithy.api#jsonName": "subnetId" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The VPC ID of the EC2 instance.
", + "smithy.api#jsonName": "vpcId" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the elastic network interface of the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#NetworkInterfaces": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#NetworkInterface" + } + }, + "com.amazonaws.guardduty#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.guardduty#NotEquals": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#ObservationTexts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Observations": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.guardduty#ObservationTexts", + "traits": { + "smithy.api#documentation": "The text that was unusual.
", + "smithy.api#jsonName": "text" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the observed behavior.
" + } + }, + "com.amazonaws.guardduty#OrderBy": { + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" + } + } + } + }, + "com.amazonaws.guardduty#OrgFeature": { + "type": "enum", + "members": { + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNTIME_MONITORING" + } + } + } + }, + "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration": { + "type": "enum", + "members": { + "EKS_ADDON_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_ADDON_MANAGEMENT" + } + }, + "ECS_FARGATE_AGENT_MANAGEMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS_FARGATE_AGENT_MANAGEMENT" + } + } + } + }, + "com.amazonaws.guardduty#OrgFeatureStatus": { + "type": "enum", + "members": { + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.guardduty#Organization": { + "type": "structure", + "members": { + "Asn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Autonomous System Number (ASN) of the internet provider of the remote IP\n address.
", + "smithy.api#jsonName": "asn" + } + }, + "AsnOrg": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The organization that registered this ASN.
", + "smithy.api#jsonName": "asnOrg" + } + }, + "Isp": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ISP information for the internet provider.
", + "smithy.api#jsonName": "isp" + } + }, + "Org": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the internet provider.
", + "smithy.api#jsonName": "org" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the ISP organization of the remote IP address.
" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "The name of the additional configuration that will be configured for the\n organization.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "The status of the additional configuration that will be configured for the\n organization. Use one of the following \n values to configure the feature status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the additional configuration enabled automatically.
\n ALL: Indicates that all accounts in the organization have \n the additional configuration\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the additional configuration will not be \n automatically enabled for any\n account in the organization. The administrator must manage the additional configuration \n for each account individually.
A list of additional configurations which will be configured for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "The name of the additional configuration that is configured for the member accounts within\n the organization.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "Describes the status of the additional configuration that is configured for the\n member accounts within the organization. One of the following \n values is the status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the additional configuration enabled automatically.
\n ALL: Indicates that all accounts in the organization have \n the additional configuration\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the additional configuration will not be \n automatically enabled for any\n account in the organization. The administrator must manage the additional configuration \n for each account individually.
A list of additional configuration which will be configured for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult" + } + }, + "com.amazonaws.guardduty#OrganizationAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#OrganizationDataSourceConfigurations": { + "type": "structure", + "members": { + "S3Logs": { + "target": "com.amazonaws.guardduty#OrganizationS3LogsConfiguration", + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs are enabled for new members of the\n organization.
", + "smithy.api#jsonName": "s3Logs" + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesConfiguration", + "traits": { + "smithy.api#documentation": "Describes the configuration of Kubernetes data sources for new members of the\n organization.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection for new members of the\n organization.
", + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on which data sources will be configured to be\n automatically enabled for new members within the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationDataSourceConfigurationsResult": { + "type": "structure", + "members": { + "S3Logs": { + "target": "com.amazonaws.guardduty#OrganizationS3LogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Describes whether S3 data event logs are enabled as a data source.
", + "smithy.api#jsonName": "s3Logs", + "smithy.api#required": {} + } + }, + "Kubernetes": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Kubernetes data sources.
", + "smithy.api#jsonName": "kubernetes" + } + }, + "MalwareProtection": { + "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of Malware Protection data source for an organization.
", + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on which data sources are automatically enabled for\n new members within the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationDetails": { + "type": "structure", + "members": { + "UpdatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the organization statistics\n was last updated. This is in\n UTC format.
", + "smithy.api#jsonName": "updatedAt" + } + }, + "OrganizationStatistics": { + "target": "com.amazonaws.guardduty#OrganizationStatistics", + "traits": { + "smithy.api#documentation": "Information about the GuardDuty coverage statistics \n for members in your Amazon Web Services organization.
", + "smithy.api#jsonName": "organizationStatistics" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about GuardDuty coverage statistics for members\n in your Amazon Web Services organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationEbsVolumes": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the\n organization.
", + "smithy.api#jsonName": "autoEnable" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide EBS volumes scan configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationEbsVolumesResult": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "An object that contains the status of whether scanning EBS volumes should be auto-enabled\n for new members joining the organization.
", + "smithy.api#jsonName": "autoEnable" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of whether EBS volumes scanning will be\n enabled as a data source for an organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "The name of the feature that will be configured for the organization.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "Describes the status of the feature that is configured for the\n member accounts within the organization. One of the following \n values is the status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the feature will not be \n automatically enabled for any\n account in the organization. The administrator must manage the feature\n for each account individually.
The additional information that will be configured for the organization.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of features which will be configured for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureConfigurationResult": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "The name of the feature that is configured for the member accounts within the\n organization.
", + "smithy.api#jsonName": "name" + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#OrgFeatureStatus", + "traits": { + "smithy.api#documentation": "Describes the status of the feature that is configured for the member accounts within\n the organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature \n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that the feature will not be automatically enabled for any\n account in the organization. In this case, each account will be managed individually \n by the\n administrator.
The additional configuration that is configured for the member accounts within the\n organization.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of features which will be configured for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatistics": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeature", + "traits": { + "smithy.api#documentation": "Name of the feature.
", + "smithy.api#jsonName": "name" + } + }, + "EnabledAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts that have enabled a specific\n feature.
", + "smithy.api#jsonName": "enabledAccountsCount" + } + }, + "AdditionalConfiguration": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfigurations", + "traits": { + "smithy.api#documentation": "Name of the additional configuration.
", + "smithy.api#jsonName": "additionalConfiguration" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the number of accounts\n that have enabled a specific feature.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", + "traits": { + "smithy.api#documentation": "Name of the additional configuration within a feature.
", + "smithy.api#jsonName": "name" + } + }, + "EnabledAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts that have enabled the additional\n configuration.
", + "smithy.api#jsonName": "enabledAccountsCount" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the coverage \n statistic for the additional \n configuration of the feature.
" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatisticsAdditionalConfiguration" + } + }, + "com.amazonaws.guardduty#OrganizationFeatureStatisticsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatistics" + } + }, + "com.amazonaws.guardduty#OrganizationFeaturesConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureConfiguration" + } + }, + "com.amazonaws.guardduty#OrganizationFeaturesConfigurationsResults": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#OrganizationFeatureConfigurationResult" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfiguration": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that contains information on whether Kubernetes audit logs should be enabled\n automatically as a data source for the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide Kubernetes audit logs configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfigurationResult": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether Kubernetes audit logs data source should be auto-enabled for new members joining\n the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The current configuration of Kubernetes audit logs as a data source for the\n organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesConfiguration": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfiguration", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Whether Kubernetes audit logs data source should be auto-enabled for new members joining\n the organization.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide Kubernetes data sources configurations.
" + } + }, + "com.amazonaws.guardduty#OrganizationKubernetesConfigurationResult": { + "type": "structure", + "members": { + "AuditLogs": { + "target": "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfigurationResult", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The current configuration of Kubernetes audit logs as a data source for the\n organization.
", + "smithy.api#jsonName": "auditLogs", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The current configuration of all Kubernetes data sources for the organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings", + "traits": { + "smithy.api#documentation": "Whether Malware Protection for EC2 instances with findings should be auto-enabled for new\n members joining the organization.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide Malware Protection configurations.
" + } + }, + "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult": { + "type": "structure", + "members": { + "ScanEc2InstanceWithFindings": { + "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EC2 instances with findings for an\n organization.
", + "smithy.api#jsonName": "scanEc2InstanceWithFindings" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data source\n for an organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationS3LogsConfiguration": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that contains information on whether S3 data event logs will be enabled\n automatically as a data source for the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be automatically enabled for new members of the\n organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationS3LogsConfigurationResult": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new\n members of the organization.
", + "smithy.api#jsonName": "autoEnable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The current configuration of S3 data event logs as a data source for the\n organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#OrganizationEbsVolumes", + "traits": { + "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the\n organization.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Organization-wide EC2 instances with findings scan configuration.
" + } + }, + "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#OrganizationEbsVolumesResult", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EBS volumes for an organization.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of scanning EC2 instances with findings\n for an organization.
" + } + }, + "com.amazonaws.guardduty#OrganizationStatistics": { + "type": "structure", + "members": { + "TotalAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts in your Amazon Web Services organization.
", + "smithy.api#jsonName": "totalAccountsCount" + } + }, + "MemberAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts in your Amazon Web Services organization \n that are associated with GuardDuty.
", + "smithy.api#jsonName": "memberAccountsCount" + } + }, + "ActiveAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of active accounts in your Amazon Web Services \n organization that are associated with GuardDuty.
", + "smithy.api#jsonName": "activeAccountsCount" + } + }, + "EnabledAccountsCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of accounts that have enabled GuardDuty.
", + "smithy.api#jsonName": "enabledAccountsCount" + } + }, + "CountByFeature": { + "target": "com.amazonaws.guardduty#OrganizationFeatureStatisticsResults", + "traits": { + "smithy.api#documentation": "Retrieves the coverage \n statistics for each feature.
", + "smithy.api#jsonName": "countByFeature" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the coverage statistics of the \n features for the entire \n Amazon Web Services organization.
\nWhen you create a new Amazon Web Services organization, it might \n take up to 24 hours to \n generate the statistics summary for this organization.
" + } + }, + "com.amazonaws.guardduty#Owner": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The canonical user ID of the bucket owner. For information about locating your canonical\n user ID see Finding Your Account\n Canonical User ID.\n
", + "smithy.api#jsonName": "id" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the owner of the bucket.
" + } + }, + "com.amazonaws.guardduty#PermissionConfiguration": { + "type": "structure", + "members": { + "BucketLevelPermissions": { + "target": "com.amazonaws.guardduty#BucketLevelPermissions", + "traits": { + "smithy.api#documentation": "Contains information about the bucket level permissions for the S3 bucket.
", + "smithy.api#jsonName": "bucketLevelPermissions" + } + }, + "AccountLevelPermissions": { + "target": "com.amazonaws.guardduty#AccountLevelPermissions", + "traits": { + "smithy.api#documentation": "Contains information about the account level permissions on the S3 bucket.
", + "smithy.api#jsonName": "accountLevelPermissions" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about how permissions are configured for the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#PortProbeAction": { + "type": "structure", + "members": { + "Blocked": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.
", + "smithy.api#jsonName": "blocked" + } + }, + "PortProbeDetails": { + "target": "com.amazonaws.guardduty#PortProbeDetails", + "traits": { + "smithy.api#documentation": "A list of objects related to port probe details.
", + "smithy.api#jsonName": "portProbeDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the PORT_PROBE action described in the finding.
" + } + }, + "com.amazonaws.guardduty#PortProbeDetail": { + "type": "structure", + "members": { + "LocalPortDetails": { + "target": "com.amazonaws.guardduty#LocalPortDetails", + "traits": { + "smithy.api#documentation": "The local port information of the connection.
", + "smithy.api#jsonName": "localPortDetails" + } + }, + "LocalIpDetails": { + "target": "com.amazonaws.guardduty#LocalIpDetails", + "traits": { + "smithy.api#documentation": "The local IP information of the connection.
", + "smithy.api#jsonName": "localIpDetails" + } + }, + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#documentation": "The remote IP information of the connection.
", + "smithy.api#jsonName": "remoteIpDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the port probe details.
" + } + }, + "com.amazonaws.guardduty#PortProbeDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#PortProbeDetail" + } + }, + "com.amazonaws.guardduty#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.guardduty#PrivateIpAddressDetails": { + "type": "structure", + "members": { + "PrivateDnsName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The private DNS name of the EC2 instance.
", + "smithy.api#jsonName": "privateDnsName" + } + }, + "PrivateIpAddress": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The private IP address of the EC2 instance.
", + "smithy.api#jsonName": "privateIpAddress" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains other private IP address information of the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#PrivateIpAddresses": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#PrivateIpAddressDetails" + } + }, + "com.amazonaws.guardduty#ProcessDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the process.
", + "smithy.api#jsonName": "name" + } + }, + "ExecutablePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The absolute path of the process executable file.
", + "smithy.api#jsonName": "executablePath" + } + }, + "ExecutableSha256": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The SHA256 hash of the process executable.
The ID of the child process.
", + "smithy.api#jsonName": "namespacePid" + } + }, + "Pwd": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The present working directory of the process.
", + "smithy.api#jsonName": "pwd" + } + }, + "Pid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The ID of the process.
", + "smithy.api#jsonName": "pid" + } + }, + "StartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the process started. This is in UTC format.
", + "smithy.api#jsonName": "startTime" + } + }, + "Uuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID assigned to the process by GuardDuty.
", + "smithy.api#jsonName": "uuid" + } + }, + "ParentUuid": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID of the parent process. This ID is assigned to the parent process by\n GuardDuty.
", + "smithy.api#jsonName": "parentUuid" + } + }, + "User": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The user that executed the process.
", + "smithy.api#jsonName": "user" + } + }, + "UserId": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The unique ID of the user that executed the process.
", + "smithy.api#jsonName": "userId" + } + }, + "Euid": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The effective user ID of the user that executed the process.
", + "smithy.api#jsonName": "euid" + } + }, + "Lineage": { + "target": "com.amazonaws.guardduty#Lineage", + "traits": { + "smithy.api#documentation": "Information about the process's lineage.
", + "smithy.api#jsonName": "lineage" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the observed process.
" + } + }, + "com.amazonaws.guardduty#ProductCode": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The product code information.
", + "smithy.api#jsonName": "productCodeId" + } + }, + "ProductType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The product code type.
", + "smithy.api#jsonName": "productCodeType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the product code for the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#ProductCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ProductCode" + } + }, + "com.amazonaws.guardduty#ProfileSubtype": { + "type": "enum", + "members": { + "FREQUENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FREQUENT" + } + }, + "INFREQUENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFREQUENT" + } + }, + "UNSEEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNSEEN" + } + }, + "RARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RARE" + } + } + } + }, + "com.amazonaws.guardduty#ProfileType": { + "type": "enum", + "members": { + "FREQUENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FREQUENCY" + } + } + } + }, + "com.amazonaws.guardduty#PublicAccess": { + "type": "structure", + "members": { + "PermissionConfiguration": { + "target": "com.amazonaws.guardduty#PermissionConfiguration", + "traits": { + "smithy.api#documentation": "Contains information about how permissions are configured for the S3 bucket.
", + "smithy.api#jsonName": "permissionConfiguration" + } + }, + "EffectivePermission": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes the effective permission on this bucket after factoring all attached\n policies.
", + "smithy.api#jsonName": "effectivePermission" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#PublishingStatus": { + "type": "enum", + "members": { + "PENDING_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING_VERIFICATION" + } + }, + "PUBLISHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHING" + } + }, + "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#RdsDbInstanceDetails": { + "type": "structure", + "members": { + "DbInstanceIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The identifier associated to the database instance that was involved in the\n finding.
", + "smithy.api#jsonName": "dbInstanceIdentifier" + } + }, + "Engine": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The database engine of the database instance involved in the finding.
", + "smithy.api#jsonName": "engine" + } + }, + "EngineVersion": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the database engine that was involved in the finding.
", + "smithy.api#jsonName": "engineVersion" + } + }, + "DbClusterIdentifier": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The identifier of the database cluster that contains the database instance ID involved in\n the finding.
", + "smithy.api#jsonName": "dbClusterIdentifier" + } + }, + "DbInstanceArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the database instance involved in the\n finding.
", + "smithy.api#jsonName": "dbInstanceArn" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "Instance tag key-value pairs associated with the database instance ID.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the resource type RDSDBInstance involved in a\n GuardDuty finding.
The user name used in the anomalous login attempt.
", + "smithy.api#jsonName": "user" + } + }, + "Application": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The application name used in the anomalous login attempt.
", + "smithy.api#jsonName": "application" + } + }, + "Database": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the database instance involved in the anomalous login attempt.
", + "smithy.api#jsonName": "database" + } + }, + "Ssl": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The version of the Secure Socket Layer (SSL) used for the network.
", + "smithy.api#jsonName": "ssl" + } + }, + "AuthMethod": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The authentication method used by the user involved in the finding.
", + "smithy.api#jsonName": "authMethod" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the user and authentication details for a database instance\n involved in the finding.
" + } + }, + "com.amazonaws.guardduty#RdsLoginAttemptAction": { + "type": "structure", + "members": { + "RemoteIpDetails": { + "target": "com.amazonaws.guardduty#RemoteIpDetails", + "traits": { + "smithy.api#jsonName": "remoteIpDetails" + } + }, + "LoginAttributes": { + "target": "com.amazonaws.guardduty#LoginAttributes", + "traits": { + "smithy.api#documentation": "Indicates the login attributes used in the login attempt.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates that a login attempt was made to the potentially compromised database from a\n remote IP address.
" + } + }, + "com.amazonaws.guardduty#RemoteAccountDetails": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the remote API caller.
", + "smithy.api#jsonName": "accountId" + } + }, + "Affiliated": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Details on whether the Amazon Web Services account of the remote API caller is related to your GuardDuty\n environment. If this value is True the API caller is affiliated to your account\n in some way. If it is False the API caller is from outside your\n environment.
Contains details about the remote Amazon Web Services account that made the API call.
" + } + }, + "com.amazonaws.guardduty#RemoteIpDetails": { + "type": "structure", + "members": { + "City": { + "target": "com.amazonaws.guardduty#City", + "traits": { + "smithy.api#documentation": "The city information of the remote IP address.
", + "smithy.api#jsonName": "city" + } + }, + "Country": { + "target": "com.amazonaws.guardduty#Country", + "traits": { + "smithy.api#documentation": "The country code of the remote IP address.
", + "smithy.api#jsonName": "country" + } + }, + "GeoLocation": { + "target": "com.amazonaws.guardduty#GeoLocation", + "traits": { + "smithy.api#documentation": "The location information of the remote IP address.
", + "smithy.api#jsonName": "geoLocation" + } + }, + "IpAddressV4": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The IPv4 remote address of the connection.
", + "smithy.api#jsonName": "ipAddressV4" + } + }, + "Organization": { + "target": "com.amazonaws.guardduty#Organization", + "traits": { + "smithy.api#documentation": "The ISP organization information of the remote IP address.
", + "smithy.api#jsonName": "organization" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the remote IP address of the connection.
" + } + }, + "com.amazonaws.guardduty#RemotePortDetails": { + "type": "structure", + "members": { + "Port": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The port number of the remote connection.
", + "smithy.api#jsonName": "port" + } + }, + "PortName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The port name of the remote connection.
", + "smithy.api#jsonName": "portName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the remote port.
" + } + }, + "com.amazonaws.guardduty#Resource": { + "type": "structure", + "members": { + "AccessKeyDetails": { + "target": "com.amazonaws.guardduty#AccessKeyDetails", + "traits": { + "smithy.api#documentation": "The IAM access key details (user information) of a user that engaged in the activity that\n prompted GuardDuty to generate a finding.
", + "smithy.api#jsonName": "accessKeyDetails" + } + }, + "S3BucketDetails": { + "target": "com.amazonaws.guardduty#S3BucketDetails", + "traits": { + "smithy.api#documentation": "Contains information on the S3 bucket.
", + "smithy.api#jsonName": "s3BucketDetails" + } + }, + "InstanceDetails": { + "target": "com.amazonaws.guardduty#InstanceDetails", + "traits": { + "smithy.api#documentation": "The information about the EC2 instance associated with the activity that prompted\n GuardDuty to generate a finding.
", + "smithy.api#jsonName": "instanceDetails" + } + }, + "EksClusterDetails": { + "target": "com.amazonaws.guardduty#EksClusterDetails", + "traits": { + "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
", + "smithy.api#jsonName": "eksClusterDetails" + } + }, + "KubernetesDetails": { + "target": "com.amazonaws.guardduty#KubernetesDetails", + "traits": { + "smithy.api#documentation": "Details about the Kubernetes user and workload involved in a Kubernetes finding.
", + "smithy.api#jsonName": "kubernetesDetails" + } + }, + "ResourceType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The type of Amazon Web Services resource.
", + "smithy.api#jsonName": "resourceType" + } + }, + "EbsVolumeDetails": { + "target": "com.amazonaws.guardduty#EbsVolumeDetails", + "traits": { + "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
", + "smithy.api#jsonName": "ebsVolumeDetails" + } + }, + "EcsClusterDetails": { + "target": "com.amazonaws.guardduty#EcsClusterDetails", + "traits": { + "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
", + "smithy.api#jsonName": "ecsClusterDetails" + } + }, + "ContainerDetails": { + "target": "com.amazonaws.guardduty#Container", + "traits": { + "smithy.api#jsonName": "containerDetails" + } + }, + "RdsDbInstanceDetails": { + "target": "com.amazonaws.guardduty#RdsDbInstanceDetails", + "traits": { + "smithy.api#documentation": "Contains information about the database instance to which an anomalous login attempt was\n made.
", + "smithy.api#jsonName": "rdsDbInstanceDetails" + } + }, + "RdsDbUserDetails": { + "target": "com.amazonaws.guardduty#RdsDbUserDetails", + "traits": { + "smithy.api#documentation": "Contains information about the user details through which anomalous login attempt was\n made.
", + "smithy.api#jsonName": "rdsDbUserDetails" + } + }, + "LambdaDetails": { + "target": "com.amazonaws.guardduty#LambdaDetails", + "traits": { + "smithy.api#documentation": "Contains information about the Lambda function that was involved in a finding.
", + "smithy.api#jsonName": "lambdaDetails" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon Web Services resource associated with the activity that prompted\n GuardDuty to generate a finding.
" + } + }, + "com.amazonaws.guardduty#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[A-Za-z-]+:[A-Za-z0-9]+:[A-Za-z0-9-]+:\\d+:(([A-Za-z0-9-]+)[:\\/])?[A-Za-z0-9-]*$" + } + }, + "com.amazonaws.guardduty#ResourceDetails": { + "type": "structure", + "members": { + "InstanceArn": { + "target": "com.amazonaws.guardduty#InstanceArn", + "traits": { + "smithy.api#documentation": "InstanceArn that was scanned in the scan entry.
", + "smithy.api#jsonName": "instanceArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
" + } + }, + "com.amazonaws.guardduty#ResourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#ResourceType": { + "type": "enum", + "members": { + "EKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS" + } + }, + "ECS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECS" + } + }, + "EC2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2" + } + } + } + }, + "com.amazonaws.guardduty#RuntimeContext": { + "type": "structure", + "members": { + "ModifyingProcess": { + "target": "com.amazonaws.guardduty#ProcessDetails", + "traits": { + "smithy.api#documentation": "Information about the process that modified the current process. This is available for\n multiple finding types.
", + "smithy.api#jsonName": "modifyingProcess" + } + }, + "ModifiedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the process modified the current process. The timestamp is in UTC date string\n format.
", + "smithy.api#jsonName": "modifiedAt" + } + }, + "ScriptPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the script that was executed.
", + "smithy.api#jsonName": "scriptPath" + } + }, + "LibraryPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the new library that was loaded.
", + "smithy.api#jsonName": "libraryPath" + } + }, + "LdPreloadValue": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The value of the LD_PRELOAD environment variable.
", + "smithy.api#jsonName": "ldPreloadValue" + } + }, + "SocketPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the docket socket that was accessed.
", + "smithy.api#jsonName": "socketPath" + } + }, + "RuncBinaryPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the leveraged runc implementation.
The path in the container that modified the release agent file.
", + "smithy.api#jsonName": "releaseAgentPath" + } + }, + "MountSource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path on the host that is mounted by the container.
", + "smithy.api#jsonName": "mountSource" + } + }, + "MountTarget": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path in the container that is mapped to the host directory.
", + "smithy.api#jsonName": "mountTarget" + } + }, + "FileSystemType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the type of mounted fileSystem.
", + "smithy.api#jsonName": "fileSystemType" + } + }, + "Flags": { + "target": "com.amazonaws.guardduty#FlagsList", + "traits": { + "smithy.api#documentation": "Represents options that control the behavior of a runtime operation or action. For\n example, a filesystem mount operation may contain a read-only flag.
", + "smithy.api#jsonName": "flags" + } + }, + "ModuleName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the module loaded into the kernel.
", + "smithy.api#jsonName": "moduleName" + } + }, + "ModuleFilePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The path to the module loaded into the kernel.
", + "smithy.api#jsonName": "moduleFilePath" + } + }, + "ModuleSha256": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The SHA256 hash of the module.
The path to the modified shell history file.
", + "smithy.api#jsonName": "shellHistoryFilePath" + } + }, + "TargetProcess": { + "target": "com.amazonaws.guardduty#ProcessDetails", + "traits": { + "smithy.api#documentation": "Information about the process that had its memory overwritten by the current process.
", + "smithy.api#jsonName": "targetProcess" + } + }, + "AddressFamily": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the communication protocol associated with the address. For example, the address\n family AF_INET is used for IP version of 4 protocol.
Specifies a particular protocol within the address family. Usually there is a single\n protocol in address families. For example, the address family AF_INET only has\n the IP protocol.
Specifies the Region of a process's address space such as stack and heap.
", + "smithy.api#jsonName": "memoryRegions" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional information about the suspicious activity.
" + } + }, + "com.amazonaws.guardduty#RuntimeDetails": { + "type": "structure", + "members": { + "Process": { + "target": "com.amazonaws.guardduty#ProcessDetails", + "traits": { + "smithy.api#documentation": "Information about the observed process.
", + "smithy.api#jsonName": "process" + } + }, + "Context": { + "target": "com.amazonaws.guardduty#RuntimeContext", + "traits": { + "smithy.api#documentation": "Additional information about the suspicious activity.
", + "smithy.api#jsonName": "context" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the process and any required context values for a specific\n finding.
" + } + }, + "com.amazonaws.guardduty#S3BucketDetail": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket.
", + "smithy.api#jsonName": "arn" + } + }, + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket.
", + "smithy.api#jsonName": "name" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes whether the bucket is a source or destination bucket.
", + "smithy.api#jsonName": "type" + } + }, + "CreatedAt": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time the bucket was created at.
", + "smithy.api#jsonName": "createdAt" + } + }, + "Owner": { + "target": "com.amazonaws.guardduty#Owner", + "traits": { + "smithy.api#documentation": "The owner of the S3 bucket.
", + "smithy.api#jsonName": "owner" + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#Tags", + "traits": { + "smithy.api#documentation": "All tags attached to the S3 bucket
", + "smithy.api#jsonName": "tags" + } + }, + "DefaultServerSideEncryption": { + "target": "com.amazonaws.guardduty#DefaultServerSideEncryption", + "traits": { + "smithy.api#documentation": "Describes the server side encryption method used in the S3 bucket.
", + "smithy.api#jsonName": "defaultServerSideEncryption" + } + }, + "PublicAccess": { + "target": "com.amazonaws.guardduty#PublicAccess", + "traits": { + "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
", + "smithy.api#jsonName": "publicAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the S3 bucket.
" + } + }, + "com.amazonaws.guardduty#S3BucketDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#S3BucketDetail" + } + }, + "com.amazonaws.guardduty#S3LogsConfiguration": { + "type": "structure", + "members": { + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The status of S3 data event logs as a data source.
", + "smithy.api#jsonName": "enable", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#S3LogsConfigurationResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.guardduty#DataSourceStatus", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new\n members of the organization.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#Scan": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
", + "smithy.api#jsonName": "detectorId" + } + }, + "AdminDetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique detector ID of the administrator account that the request is associated with.\n Note that this value will be the same as the one used for DetectorId if the\n account is an administrator.
The unique scan ID associated with a scan entry.
", + "smithy.api#jsonName": "scanId" + } + }, + "ScanStatus": { + "target": "com.amazonaws.guardduty#ScanStatus", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan statuses.
", + "smithy.api#jsonName": "scanStatus" + } + }, + "FailureReason": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "Represents the reason for FAILED scan status.
", + "smithy.api#jsonName": "failureReason" + } + }, + "ScanStartTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the scan was triggered.
", + "smithy.api#jsonName": "scanStartTime" + } + }, + "ScanEndTime": { + "target": "com.amazonaws.guardduty#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the scan was finished.
", + "smithy.api#jsonName": "scanEndTime" + } + }, + "TriggerDetails": { + "target": "com.amazonaws.guardduty#TriggerDetails", + "traits": { + "smithy.api#documentation": "Specifies the reason why the scan was initiated.
", + "smithy.api#jsonName": "triggerDetails" + } + }, + "ResourceDetails": { + "target": "com.amazonaws.guardduty#ResourceDetails", + "traits": { + "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
", + "smithy.api#jsonName": "resourceDetails" + } + }, + "ScanResultDetails": { + "target": "com.amazonaws.guardduty#ScanResultDetails", + "traits": { + "smithy.api#documentation": "Represents the result of the scan.
", + "smithy.api#jsonName": "scanResultDetails" + } + }, + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The ID for the account that belongs to the scan.
", + "smithy.api#jsonName": "accountId" + } + }, + "TotalBytes": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "Represents total bytes that were scanned.
", + "smithy.api#jsonName": "totalBytes" + } + }, + "FileCount": { + "target": "com.amazonaws.guardduty#PositiveLong", + "traits": { + "smithy.api#documentation": "Represents the number of files that were scanned.
", + "smithy.api#jsonName": "fileCount" + } + }, + "AttachedVolumes": { + "target": "com.amazonaws.guardduty#VolumeDetails", + "traits": { + "smithy.api#documentation": "List of volumes that were attached to the original instance to be scanned.
", + "smithy.api#jsonName": "attachedVolumes" + } + }, + "ScanType": { + "target": "com.amazonaws.guardduty#ScanType", + "traits": { + "smithy.api#documentation": "Specifies the scan type that invoked the malware scan.
", + "smithy.api#jsonName": "scanType" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a malware scan.
" + } + }, + "com.amazonaws.guardduty#ScanCondition": { + "type": "structure", + "members": { + "MapEquals": { + "target": "com.amazonaws.guardduty#MapEquals", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents an mapEqual\n condition to be applied\n to a single field when triggering for malware scan.
", + "smithy.api#jsonName": "mapEquals", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the condition.
" + } + }, + "com.amazonaws.guardduty#ScanConditionPair": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.guardduty#TagKey", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Represents the key in the map condition.
", + "smithy.api#jsonName": "key", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.guardduty#TagValue", + "traits": { + "smithy.api#documentation": "Represents optional value in the map\n condition. If not specified, only the key will be\n matched.
", + "smithy.api#jsonName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the key:value pair to be matched against given resource property.
Represents a map of resource properties that match specified conditions and values when\n triggering malware scans.
" + } + }, + "com.amazonaws.guardduty#ScanCriterionKey": { + "type": "enum", + "members": { + "EC2_INSTANCE_TAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_INSTANCE_TAG" + } + } + }, + "traits": { + "smithy.api#documentation": "An enum value representing possible resource properties to match with given scan\n condition.
" + } + }, + "com.amazonaws.guardduty#ScanDetections": { + "type": "structure", + "members": { + "ScannedItemCount": { + "target": "com.amazonaws.guardduty#ScannedItemCount", + "traits": { + "smithy.api#documentation": "Total number of scanned files.
", + "smithy.api#jsonName": "scannedItemCount" + } + }, + "ThreatsDetectedItemCount": { + "target": "com.amazonaws.guardduty#ThreatsDetectedItemCount", + "traits": { + "smithy.api#documentation": "Total number of infected files.
", + "smithy.api#jsonName": "threatsDetectedItemCount" + } + }, + "HighestSeverityThreatDetails": { + "target": "com.amazonaws.guardduty#HighestSeverityThreatDetails", + "traits": { + "smithy.api#documentation": "Details of the highest severity threat detected during malware scan and number of infected\n files.
", + "smithy.api#jsonName": "highestSeverityThreatDetails" + } + }, + "ThreatDetectedByName": { + "target": "com.amazonaws.guardduty#ThreatDetectedByName", + "traits": { + "smithy.api#documentation": "Contains details about identified threats organized by threat name.
", + "smithy.api#jsonName": "threatDetectedByName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a complete view providing malware scan result details.
" + } + }, + "com.amazonaws.guardduty#ScanEc2InstanceWithFindings": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Describes the configuration for scanning EBS volumes as data source.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings will be enabled as a\n data source.
" + } + }, + "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult": { + "type": "structure", + "members": { + "EbsVolumes": { + "target": "com.amazonaws.guardduty#EbsVolumesResult", + "traits": { + "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
", + "smithy.api#jsonName": "ebsVolumes" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information on the status of whether Malware Protection for EC2\n instances with findings will be enabled as a data source.
" + } + }, + "com.amazonaws.guardduty#ScanFilePath": { + "type": "structure", + "members": { + "FilePath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The file path of the infected file.
", + "smithy.api#jsonName": "filePath" + } + }, + "VolumeArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume Arn details of the infected file.
", + "smithy.api#jsonName": "volumeArn" + } + }, + "Hash": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The hash value of the infected file.
", + "smithy.api#jsonName": "hash" + } + }, + "FileName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "File name of the infected file.
", + "smithy.api#jsonName": "fileName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of infected file including name, file path and hash.
" + } + }, + "com.amazonaws.guardduty#ScanResourceCriteria": { + "type": "structure", + "members": { + "Include": { + "target": "com.amazonaws.guardduty#ScanCriterion", + "traits": { + "smithy.api#documentation": "Represents condition that when matched will allow a malware scan for a certain\n resource.
", + "smithy.api#jsonName": "include" + } + }, + "Exclude": { + "target": "com.amazonaws.guardduty#ScanCriterion", + "traits": { + "smithy.api#documentation": "Represents condition that when matched will prevent a malware scan for a certain\n resource.
", + "smithy.api#jsonName": "exclude" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about criteria used to filter resources before triggering malware\n scan.
" + } + }, + "com.amazonaws.guardduty#ScanResult": { + "type": "enum", + "members": { + "CLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLEAN" + } + }, + "INFECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFECTED" + } + } + } + }, + "com.amazonaws.guardduty#ScanResultDetails": { + "type": "structure", + "members": { + "ScanResult": { + "target": "com.amazonaws.guardduty#ScanResult", + "traits": { + "smithy.api#documentation": "An enum value representing possible scan results.
", + "smithy.api#jsonName": "scanResult" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the result of the scan.
" + } + }, + "com.amazonaws.guardduty#ScanStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + } + } + }, + "com.amazonaws.guardduty#ScanThreatName": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the identified threat.
", + "smithy.api#jsonName": "name" + } + }, + "Severity": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Severity of threat identified as part of the malware scan.
", + "smithy.api#jsonName": "severity" + } + }, + "ItemCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of files infected with given threat.
", + "smithy.api#jsonName": "itemCount" + } + }, + "FilePaths": { + "target": "com.amazonaws.guardduty#FilePaths", + "traits": { + "smithy.api#documentation": "List of infected files in EBS volume with details.
", + "smithy.api#jsonName": "filePaths" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains files infected with the given threat providing details of malware name and\n severity.
" + } + }, + "com.amazonaws.guardduty#ScanThreatNames": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ScanThreatName" + } + }, + "com.amazonaws.guardduty#ScanType": { + "type": "enum", + "members": { + "GUARDDUTY_INITIATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GUARDDUTY_INITIATED" + } + }, + "ON_DEMAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ON_DEMAND" + } + } + } + }, + "com.amazonaws.guardduty#ScannedItemCount": { + "type": "structure", + "members": { + "TotalGb": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total GB of files scanned for malware.
", + "smithy.api#jsonName": "totalGb" + } + }, + "Files": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Number of files scanned.
", + "smithy.api#jsonName": "files" + } + }, + "Volumes": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of scanned volumes.
", + "smithy.api#jsonName": "volumes" + } + } + }, + "traits": { + "smithy.api#documentation": "Total number of scanned files.
" + } + }, + "com.amazonaws.guardduty#Scans": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Scan" + } + }, + "com.amazonaws.guardduty#SecurityContext": { + "type": "structure", + "members": { + "Privileged": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether the container is privileged.
", + "smithy.api#jsonName": "privileged" + } + }, + "AllowPrivilegeEscalation": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process.
", + "smithy.api#jsonName": "allowPrivilegeEscalation" + } + } + }, + "traits": { + "smithy.api#documentation": "Container security context.
" + } + }, + "com.amazonaws.guardduty#SecurityGroup": { + "type": "structure", + "members": { + "GroupId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The security group ID of the EC2 instance.
", + "smithy.api#jsonName": "groupId" + } + }, + "GroupName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The security group name of the EC2 instance.
", + "smithy.api#jsonName": "groupName" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the security groups associated with the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#SecurityGroup" + } + }, + "com.amazonaws.guardduty#Service": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.guardduty#Action", + "traits": { + "smithy.api#documentation": "Information about the activity that is described in a finding.
", + "smithy.api#jsonName": "action" + } + }, + "Evidence": { + "target": "com.amazonaws.guardduty#Evidence", + "traits": { + "smithy.api#documentation": "An evidence object associated with the service.
", + "smithy.api#jsonName": "evidence" + } + }, + "Archived": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether this finding is archived.
", + "smithy.api#jsonName": "archived" + } + }, + "Count": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "The total count of the occurrences of this finding type.
", + "smithy.api#jsonName": "count" + } + }, + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID for the GuardDuty service.
", + "smithy.api#jsonName": "detectorId" + } + }, + "EventFirstSeen": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The first-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.
", + "smithy.api#jsonName": "eventFirstSeen" + } + }, + "EventLastSeen": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The last-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.
", + "smithy.api#jsonName": "eventLastSeen" + } + }, + "ResourceRole": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The resource role information for this finding.
", + "smithy.api#jsonName": "resourceRole" + } + }, + "ServiceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon Web Services service (GuardDuty) that generated a finding.
", + "smithy.api#jsonName": "serviceName" + } + }, + "UserFeedback": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Feedback that was submitted about the finding.
", + "smithy.api#jsonName": "userFeedback" + } + }, + "AdditionalInfo": { + "target": "com.amazonaws.guardduty#ServiceAdditionalInfo", + "traits": { + "smithy.api#documentation": "Contains additional information about the generated finding.
", + "smithy.api#jsonName": "additionalInfo" + } + }, + "FeatureName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the feature that generated a finding.
", + "smithy.api#jsonName": "featureName" + } + }, + "EbsVolumeScanDetails": { + "target": "com.amazonaws.guardduty#EbsVolumeScanDetails", + "traits": { + "smithy.api#documentation": "Returns details from the malware scan that created a finding.
", + "smithy.api#jsonName": "ebsVolumeScanDetails" + } + }, + "RuntimeDetails": { + "target": "com.amazonaws.guardduty#RuntimeDetails", + "traits": { + "smithy.api#documentation": "Information about the process and any required context values for a specific\n finding
", + "smithy.api#jsonName": "runtimeDetails" + } + }, + "Detection": { + "target": "com.amazonaws.guardduty#Detection", + "traits": { + "smithy.api#documentation": "Contains information about the detected unusual behavior.
", + "smithy.api#jsonName": "detection" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains additional information about the generated finding.
" + } + }, + "com.amazonaws.guardduty#ServiceAdditionalInfo": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "This field specifies the value of the additional information.
", + "smithy.api#jsonName": "value" + } + }, + "Type": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Describes the type of the additional information.
", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional information about the generated finding.
" + } + }, + "com.amazonaws.guardduty#SessionNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#SortCriteria": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Represents the finding attribute, such as accountId, that sorts the\n findings.
The order by which the sorted findings are to be displayed.
", + "smithy.api#jsonName": "orderBy" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the criteria used for sorting findings.
" + } + }, + "com.amazonaws.guardduty#SourceIps": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Sources": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#StartMalwareScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#StartMalwareScanRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#StartMalwareScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#ConflictException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/malware-scan/start", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#StartMalwareScanRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#ResourceArn", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource for which you invoked the API.
", + "smithy.api#jsonName": "resourceArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#StartMalwareScanResponse": { + "type": "structure", + "members": { + "ScanId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each malware scan has \n a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", + "smithy.api#jsonName": "scanId" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#StartMonitoringMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#StartMonitoringMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#StartMonitoringMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Turns on GuardDuty monitoring of the specified member accounts. Use this operation to\n restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/start", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#StartMonitoringMembersRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector of the GuardDuty administrator account associated with the\n member accounts to monitor.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts to start monitoring.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#StartMonitoringMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#StopMonitoringMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#StopMonitoringMembersRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#StopMonitoringMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Stops GuardDuty monitoring for the specified member accounts. Use the\n StartMonitoringMembers operation to restart monitoring for those\n accounts.
With autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to stop monitoring the member\n accounts in your organization.
The unique ID of the detector associated with the GuardDuty administrator account that is\n monitoring member accounts.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of account IDs for the member accounts to stop monitoring.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#StopMonitoringMembersResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of objects that contain an accountId for each account that could not be processed,\n and a result string that indicates why the account was not processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#String": { + "type": "string" + }, + "com.amazonaws.guardduty#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EC2 instance tag key.
", + "smithy.api#jsonName": "key" + } + }, + "Value": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EC2 instance tag value.
", + "smithy.api#jsonName": "value" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a tag associated with the EC2 instance.
" + } + }, + "com.amazonaws.guardduty#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.guardduty#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.guardduty#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.guardduty#TagKey" + }, + "value": { + "target": "com.amazonaws.guardduty#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.guardduty#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Adds tags to a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.guardduty#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#GuardDutyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "resourceArn", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.guardduty#TagMap", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The tags to be added to a resource.
", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.guardduty#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Tag" + } + }, + "com.amazonaws.guardduty#ThreatDetectedByName": { + "type": "structure", + "members": { + "ItemCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files identified.
", + "smithy.api#jsonName": "itemCount" + } + }, + "UniqueThreatNameCount": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of unique threats by name identified, as part of the malware scan.
", + "smithy.api#jsonName": "uniqueThreatNameCount" + } + }, + "Shortened": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Flag to determine if the finding contains every single infected file-path and/or every\n threat.
", + "smithy.api#jsonName": "shortened" + } + }, + "ThreatNames": { + "target": "com.amazonaws.guardduty#ScanThreatNames", + "traits": { + "smithy.api#documentation": "List of identified threats with details, organized by threat name.
", + "smithy.api#jsonName": "threatNames" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about identified threats organized by threat name.
" + } + }, + "com.amazonaws.guardduty#ThreatIntelSetFormat": { + "type": "enum", + "members": { + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "STIX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STIX" + } + }, + "OTX_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTX_CSV" + } + }, + "ALIEN_VAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALIEN_VAULT" + } + }, + "PROOF_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROOF_POINT" + } + }, + "FIRE_EYE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIRE_EYE" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#ThreatIntelSetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#ThreatIntelSetStatus": { + "type": "enum", + "members": { + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DEACTIVATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEACTIVATING" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETE_PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_PENDING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + } + } + }, + "com.amazonaws.guardduty#ThreatIntelligenceDetail": { + "type": "structure", + "members": { + "ThreatListName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the threat intelligence list that triggered the finding.
", + "smithy.api#jsonName": "threatListName" + } + }, + "ThreatNames": { + "target": "com.amazonaws.guardduty#ThreatNames", + "traits": { + "smithy.api#documentation": "A list of names of the threats in the threat intelligence list that triggered the\n finding.
", + "smithy.api#jsonName": "threatNames" + } + } + }, + "traits": { + "smithy.api#documentation": "An instance of a threat intelligence detail that constitutes evidence for the\n finding.
" + } + }, + "com.amazonaws.guardduty#ThreatIntelligenceDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#ThreatIntelligenceDetail" + } + }, + "com.amazonaws.guardduty#ThreatNames": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#String" + } + }, + "com.amazonaws.guardduty#ThreatsDetectedItemCount": { + "type": "structure", + "members": { + "Files": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "Total number of infected files.
", + "smithy.api#jsonName": "files" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains total number of infected files.
" + } + }, + "com.amazonaws.guardduty#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.guardduty#Total": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The total usage.
", + "smithy.api#jsonName": "amount" + } + }, + "Unit": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The currency unit that the amount is given in.
", + "smithy.api#jsonName": "unit" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the total usage with the corresponding currency unit for that value.
" + } + }, + "com.amazonaws.guardduty#TriggerDetails": { + "type": "structure", + "members": { + "GuardDutyFindingId": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID of the GuardDuty finding that triggered the malware scan.
", + "smithy.api#jsonName": "guardDutyFindingId" + } + }, + "Description": { + "target": "com.amazonaws.guardduty#NonEmptyString", + "traits": { + "smithy.api#documentation": "The description of the scan trigger.
", + "smithy.api#jsonName": "description" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the reason the scan was triggered.
" + } + }, + "com.amazonaws.guardduty#UnarchiveFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UnarchiveFindingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UnarchiveFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Unarchives GuardDuty findings specified by the findingIds.
The ID of the detector associated with the findings to unarchive.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the findings to unarchive.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UnarchiveFindingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UnprocessedAccount": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#jsonName": "accountId", + "smithy.api#required": {} + } + }, + "Result": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A reason why the account hasn't been processed.
", + "smithy.api#jsonName": "result", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the accounts that weren't processed.
" + } + }, + "com.amazonaws.guardduty#UnprocessedAccounts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UnprocessedAccount" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.guardduty#UnprocessedDataSourcesResult": { + "type": "structure", + "members": { + "MalwareProtection": { + "target": "com.amazonaws.guardduty#MalwareProtectionConfigurationResult", + "traits": { + "smithy.api#jsonName": "malwareProtection" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the names of the data sources that couldn't be enabled.
" + } + }, + "com.amazonaws.guardduty#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#AccessDeniedException" + }, + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.guardduty#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.guardduty#GuardDutyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource to remove tags from.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "resourceArn", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.guardduty#TagKeyList", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#jsonName": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateDetector": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateDetectorRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateDetectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the Amazon GuardDuty detector specified by the detectorId.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateDetectorRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "Enable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the detector is enabled or not enabled.
", + "smithy.api#jsonName": "enable" + } + }, + "FindingPublishingFrequency": { + "target": "com.amazonaws.guardduty#FindingPublishingFrequency", + "traits": { + "smithy.api#documentation": "An enum value that specifies how frequently findings are exported, such as to CloudWatch\n Events.
", + "smithy.api#jsonName": "findingPublishingFrequency" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources will be updated.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#DetectorFeatureConfigurations", + "traits": { + "smithy.api#documentation": "Provides the features that will be updated for the detector.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateDetectorResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateFilterRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateFilterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the filter specified by the filter name.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/filter/{FilterName}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateFilterRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to\n update a filter.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FilterName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The name of the filter.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "filterName", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.guardduty#FilterDescription", + "traits": { + "smithy.api#documentation": "The description of the filter. Valid characters include alphanumeric characters, and\n special characters such as hyphen, period, colon, underscore, parentheses ({ },\n [ ], and ( )), forward slash, horizontal tab, vertical tab,\n newline, form feed, return, and whitespace.
Specifies the action that is to be applied to the findings that match the filter.
", + "smithy.api#jsonName": "action" + } + }, + "Rank": { + "target": "com.amazonaws.guardduty#FilterRank", + "traits": { + "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.
", + "smithy.api#jsonName": "rank" + } + }, + "FindingCriteria": { + "target": "com.amazonaws.guardduty#FindingCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings.
", + "smithy.api#jsonName": "findingCriteria" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateFilterResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#FilterName", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The name of the filter.
", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateFindingsFeedback": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateFindingsFeedbackRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateFindingsFeedbackResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Marks the specified GuardDuty findings as useful or not useful.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/findings/feedback", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateFindingsFeedbackRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector associated with the findings to update feedback for.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "FindingIds": { + "target": "com.amazonaws.guardduty#FindingIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The IDs of the findings that you want to mark as useful or not useful.
", + "smithy.api#jsonName": "findingIds", + "smithy.api#required": {} + } + }, + "Feedback": { + "target": "com.amazonaws.guardduty#Feedback", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The feedback for the finding.
", + "smithy.api#jsonName": "feedback", + "smithy.api#required": {} + } + }, + "Comments": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Additional feedback about the GuardDuty findings.
", + "smithy.api#jsonName": "comments" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateFindingsFeedbackResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateIPSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateIPSetRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateIPSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the IPSet specified by the IPSet ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/ipset/{IpSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateIPSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose IPSet you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "IpSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID that specifies the IPSet that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "ipSetId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "The unique ID that specifies the IPSet that you want to update.
", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "The updated URI of the file that contains the IPSet.
", + "smithy.api#jsonName": "location" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "The updated Boolean value that specifies whether the IPSet is active or not.
", + "smithy.api#jsonName": "activate" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateIPSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateMalwareScanSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateMalwareScanSettingsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateMalwareScanSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the malware scan settings.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/malware-scan-settings", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateMalwareScanSettingsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to\n update scan settings.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "ScanResourceCriteria": { + "target": "com.amazonaws.guardduty#ScanResourceCriteria", + "traits": { + "smithy.api#documentation": "Represents the criteria to be used in the filter for selecting resources to scan.
", + "smithy.api#jsonName": "scanResourceCriteria" + } + }, + "EbsSnapshotPreservation": { + "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", + "traits": { + "smithy.api#documentation": "An enum value representing possible snapshot preservation settings.
", + "smithy.api#jsonName": "ebsSnapshotPreservation" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateMalwareScanSettingsResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateMemberDetectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateMemberDetectorsRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateMemberDetectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Contains information on member accounts to be updated.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/member/detector/update", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateMemberDetectorsRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detector ID of the administrator account.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of member account IDs to be updated.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceConfigurations", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "Describes which data sources will be updated.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#MemberFeaturesConfigurations", + "traits": { + "smithy.api#documentation": "A list of features that will be updated for the specified member accounts.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateMemberDetectorsResponse": { + "type": "structure", + "members": { + "UnprocessedAccounts": { + "target": "com.amazonaws.guardduty#UnprocessedAccounts", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "A list of member account IDs that were unable to be processed along with an explanation\n for why they were not processed.
", + "smithy.api#jsonName": "unprocessedAccounts", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UpdateOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.guardduty#UpdateOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.guardduty#UpdateOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.guardduty#BadRequestException" + }, + { + "target": "com.amazonaws.guardduty#InternalServerErrorException" + } + ], + "traits": { + "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/admin", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The ID of the detector that configures the delegated administrator.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "AutoEnable": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#deprecated": { + "message": "This field is deprecated, use AutoEnableOrganizationMembers instead" + }, + "smithy.api#documentation": "Represents whether or not to automatically enable member accounts in the organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results. You must provide a \n value for either autoEnableOrganizationMembers or autoEnable.
Describes which data sources will be updated.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#OrganizationFeaturesConfigurations", + "traits": { + "smithy.api#documentation": "A list of features that will be configured for the organization.
", + "smithy.api#jsonName": "features" + } + }, + "AutoEnableOrganizationMembers": { + "target": "com.amazonaws.guardduty#AutoEnableMembers", + "traits": { + "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
Use one of the \n following configuration values for autoEnableOrganizationMembers:
\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
Updates information about the publishing destination specified by the\n destinationId.
The ID of the detector associated with the publishing destinations to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "DestinationId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The ID of the publishing destination to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "destinationId", + "smithy.api#required": {} + } + }, + "DestinationProperties": { + "target": "com.amazonaws.guardduty#DestinationProperties", + "traits": { + "smithy.api#documentation": "A DestinationProperties object that includes the DestinationArn\n and KmsKeyArn of the publishing destination.
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
", + "smithy.api#http": { + "method": "POST", + "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", + "code": 200 + } + } + }, + "com.amazonaws.guardduty#UpdateThreatIntelSetRequest": { + "type": "structure", + "members": { + "DetectorId": { + "target": "com.amazonaws.guardduty#DetectorId", + "traits": { + "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to\n update.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "detectorId", + "smithy.api#required": {} + } + }, + "ThreatIntelSetId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The unique ID that specifies the ThreatIntelSet that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "threatIntelSetId", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.guardduty#Name", + "traits": { + "smithy.api#documentation": "The unique ID that specifies the ThreatIntelSet that you want to update.
", + "smithy.api#jsonName": "name" + } + }, + "Location": { + "target": "com.amazonaws.guardduty#Location", + "traits": { + "smithy.api#documentation": "The updated URI of the file that contains the ThreateIntelSet.
", + "smithy.api#jsonName": "location" + } + }, + "Activate": { + "target": "com.amazonaws.guardduty#Boolean", + "traits": { + "smithy.api#documentation": "The updated Boolean value that specifies whether the ThreateIntelSet is active or\n not.
", + "smithy.api#jsonName": "activate" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.guardduty#UpdateThreatIntelSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.guardduty#UsageAccountResult": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The Account ID that generated usage.
", + "smithy.api#jsonName": "accountId" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#documentation": "Represents the total of usage for the Account ID.
", + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the total of usage based on account IDs.
" + } + }, + "com.amazonaws.guardduty#UsageAccountResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageAccountResult" + } + }, + "com.amazonaws.guardduty#UsageCriteria": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.guardduty#AccountIds", + "traits": { + "smithy.api#documentation": "The account IDs to aggregate usage statistics from.
", + "smithy.api#jsonName": "accountIds" + } + }, + "DataSources": { + "target": "com.amazonaws.guardduty#DataSourceList", + "traits": { + "smithy.api#deprecated": { + "message": "This parameter is deprecated, use Features instead" + }, + "smithy.api#documentation": "The data sources to aggregate usage statistics from.
", + "smithy.api#jsonName": "dataSources" + } + }, + "Resources": { + "target": "com.amazonaws.guardduty#ResourceList", + "traits": { + "smithy.api#documentation": "The resources to aggregate usage statistics from. Only accepts exact resource\n names.
", + "smithy.api#jsonName": "resources" + } + }, + "Features": { + "target": "com.amazonaws.guardduty#UsageFeatureList", + "traits": { + "smithy.api#documentation": "The features to aggregate usage statistics from.
", + "smithy.api#jsonName": "features" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the criteria used to query usage statistics.
" + } + }, + "com.amazonaws.guardduty#UsageDataSourceResult": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.guardduty#DataSource", + "traits": { + "smithy.api#documentation": "The data source type that generated usage.
", + "smithy.api#jsonName": "dataSource" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#documentation": "Represents the total of usage for the specified data source.
", + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the result of usage based on data source type.
" + } + }, + "com.amazonaws.guardduty#UsageDataSourceResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageDataSourceResult" + } + }, + "com.amazonaws.guardduty#UsageFeature": { + "type": "enum", + "members": { + "FLOW_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOW_LOGS" + } + }, + "CLOUD_TRAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUD_TRAIL" + } + }, + "DNS_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_LOGS" + } + }, + "S3_DATA_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_DATA_EVENTS" + } + }, + "EKS_AUDIT_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_AUDIT_LOGS" + } + }, + "EBS_MALWARE_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" + } + }, + "RDS_LOGIN_EVENTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RDS_LOGIN_EVENTS" + } + }, + "LAMBDA_NETWORK_LOGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" + } + }, + "EKS_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" + } + }, + "FARGATE_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FARGATE_RUNTIME_MONITORING" + } + }, + "EC2_RUNTIME_MONITORING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EC2_RUNTIME_MONITORING" + } + } + } + }, + "com.amazonaws.guardduty#UsageFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageFeature" + } + }, + "com.amazonaws.guardduty#UsageFeatureResult": { + "type": "structure", + "members": { + "Feature": { + "target": "com.amazonaws.guardduty#UsageFeature", + "traits": { + "smithy.api#documentation": "The feature that generated the usage cost.
", + "smithy.api#jsonName": "feature" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the result of the total usage based on the feature.
" + } + }, + "com.amazonaws.guardduty#UsageFeatureResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageFeatureResult" + } + }, + "com.amazonaws.guardduty#UsageResourceResult": { + "type": "structure", + "members": { + "Resource": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services resource that generated usage.
", + "smithy.api#jsonName": "resource" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#documentation": "Represents the sum total of usage for the specified resource type.
", + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the sum of usage based on an Amazon Web Services resource.
" + } + }, + "com.amazonaws.guardduty#UsageResourceResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageResourceResult" + } + }, + "com.amazonaws.guardduty#UsageStatisticType": { + "type": "enum", + "members": { + "SUM_BY_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_ACCOUNT" + } + }, + "SUM_BY_DATA_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_DATA_SOURCE" + } + }, + "SUM_BY_RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_RESOURCE" + } + }, + "TOP_RESOURCES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_RESOURCES" + } + }, + "SUM_BY_FEATURES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM_BY_FEATURES" + } + }, + "TOP_ACCOUNTS_BY_FEATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_ACCOUNTS_BY_FEATURE" + } + } + } + }, + "com.amazonaws.guardduty#UsageStatistics": { + "type": "structure", + "members": { + "SumByAccount": { + "target": "com.amazonaws.guardduty#UsageAccountResultList", + "traits": { + "smithy.api#documentation": "The usage statistic sum organized by account ID.
", + "smithy.api#jsonName": "sumByAccount" + } + }, + "TopAccountsByFeature": { + "target": "com.amazonaws.guardduty#UsageTopAccountsResultList", + "traits": { + "smithy.api#documentation": "Lists the top 50 accounts by feature that have generated the most\n GuardDuty usage, in the order from most to least expensive.
\nCurrently, this doesn't support RDS_LOGIN_EVENTS.
The usage statistic sum organized by on data source.
", + "smithy.api#jsonName": "sumByDataSource" + } + }, + "SumByResource": { + "target": "com.amazonaws.guardduty#UsageResourceResultList", + "traits": { + "smithy.api#documentation": "The usage statistic sum organized by resource.
", + "smithy.api#jsonName": "sumByResource" + } + }, + "TopResources": { + "target": "com.amazonaws.guardduty#UsageResourceResultList", + "traits": { + "smithy.api#documentation": "Lists the top 50 resources that have generated the most GuardDuty usage, in order from\n most to least expensive.
", + "smithy.api#jsonName": "topResources" + } + }, + "SumByFeature": { + "target": "com.amazonaws.guardduty#UsageFeatureResultList", + "traits": { + "smithy.api#documentation": "The usage statistic sum organized by feature.
", + "smithy.api#jsonName": "sumByFeature" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the result of GuardDuty usage. If a UsageStatisticType is provided the result for\n other types will be null.
" + } + }, + "com.amazonaws.guardduty#UsageTopAccountResult": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.guardduty#AccountId", + "traits": { + "smithy.api#documentation": "The unique account ID.
", + "smithy.api#jsonName": "accountId" + } + }, + "Total": { + "target": "com.amazonaws.guardduty#Total", + "traits": { + "smithy.api#jsonName": "total" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information on the total of usage based on the topmost 50 \n account IDs.
" + } + }, + "com.amazonaws.guardduty#UsageTopAccountsByFeatureList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageTopAccountResult" + } + }, + "com.amazonaws.guardduty#UsageTopAccountsResult": { + "type": "structure", + "members": { + "Feature": { + "target": "com.amazonaws.guardduty#UsageFeature", + "traits": { + "smithy.api#documentation": "Features by which you can generate the usage statistics.
\n\n RDS_LOGIN_EVENTS is currently not supported \n with topAccountsByFeature.
The accounts that contributed to the total usage cost.
", + "smithy.api#jsonName": "accounts" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the usage statistics, calculated\n by top accounts by feature.
" + } + }, + "com.amazonaws.guardduty#UsageTopAccountsResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#UsageTopAccountsResult" + } + }, + "com.amazonaws.guardduty#Volume": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Volume name.
", + "smithy.api#jsonName": "name" + } + }, + "HostPath": { + "target": "com.amazonaws.guardduty#HostPath", + "traits": { + "smithy.api#documentation": "Represents a pre-existing file or directory on the host machine that the volume maps\n to.
", + "smithy.api#jsonName": "hostPath" + } + } + }, + "traits": { + "smithy.api#documentation": "Volume used by the Kubernetes workload.
" + } + }, + "com.amazonaws.guardduty#VolumeDetail": { + "type": "structure", + "members": { + "VolumeArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume Arn information.
", + "smithy.api#jsonName": "volumeArn" + } + }, + "VolumeType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The EBS volume type.
", + "smithy.api#jsonName": "volumeType" + } + }, + "DeviceName": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The device name for the EBS volume.
", + "smithy.api#jsonName": "deviceName" + } + }, + "VolumeSizeInGB": { + "target": "com.amazonaws.guardduty#Integer", + "traits": { + "smithy.api#documentation": "EBS volume size in GB.
", + "smithy.api#jsonName": "volumeSizeInGB" + } + }, + "EncryptionType": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "EBS volume encryption type.
", + "smithy.api#jsonName": "encryptionType" + } + }, + "SnapshotArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Snapshot Arn of the EBS volume.
", + "smithy.api#jsonName": "snapshotArn" + } + }, + "KmsKeyArn": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "KMS key Arn used to encrypt the EBS volume.
", + "smithy.api#jsonName": "kmsKeyArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains EBS volume details.
" + } + }, + "com.amazonaws.guardduty#VolumeDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#VolumeDetail" + } + }, + "com.amazonaws.guardduty#VolumeMount": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Volume mount name.
", + "smithy.api#jsonName": "name" + } + }, + "MountPath": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "Volume mount path.
", + "smithy.api#jsonName": "mountPath" + } + } + }, + "traits": { + "smithy.api#documentation": "Container volume mount.
" + } + }, + "com.amazonaws.guardduty#VolumeMounts": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#VolumeMount" + } + }, + "com.amazonaws.guardduty#Volumes": { + "type": "list", + "member": { + "target": "com.amazonaws.guardduty#Volume" + } + }, + "com.amazonaws.guardduty#VpcConfig": { + "type": "structure", + "members": { + "SubnetIds": { + "target": "com.amazonaws.guardduty#SubnetIds", + "traits": { + "smithy.api#documentation": "The identifiers of the subnets that are associated with your Lambda function.
", + "smithy.api#jsonName": "subnetIds" + } + }, + "VpcId": { + "target": "com.amazonaws.guardduty#String", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Virtual Private Cloud.
", + "smithy.api#jsonName": "vpcId" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.guardduty#SecurityGroups", + "traits": { + "smithy.api#documentation": "The identifier of the security group attached to the Lambda function.
", + "smithy.api#jsonName": "securityGroups" + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon Virtual Private Cloud configuration details associated with your Lambda function.
" } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.guardduty#GuardDutyArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[A-Za-z_.-]{1,20}:guardduty:[A-Za-z0-9_/.-]{0,63}:\\d+:detector/[A-Za-z0-9_/.-]{32,264}$" - } - }, - "com.amazonaws.guardduty#HighestSeverityThreatDetails": { - "type": "structure", - "members": { - "Severity": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Severity level of the highest severity threat detected.
", - "smithy.api#jsonName": "severity" - } - }, - "ThreatName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Threat name of the highest severity threat detected as part of the malware scan.
", - "smithy.api#jsonName": "threatName" - } - }, - "Count": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Total number of infected files with the highest severity threat detected.
", - "smithy.api#jsonName": "count" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details of the highest severity threat detected during scan and number of\n infected files.
" - } - }, - "com.amazonaws.guardduty#HostPath": { - "type": "structure", - "members": { - "Path": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Path of the file or directory on the host that the volume maps to.
", - "smithy.api#jsonName": "path" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents a pre-existing file or directory on the host machine that the volume maps\n to.
" - } - }, - "com.amazonaws.guardduty#IamInstanceProfile": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The profile ARN of the EC2 instance.
", - "smithy.api#jsonName": "arn" - } - }, - "Id": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The profile ID of the EC2 instance.
", - "smithy.api#jsonName": "id" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the EC2 instance profile.
" - } - }, - "com.amazonaws.guardduty#ImpersonatedUser": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Information about the username that was being impersonated.
The group to which the user name belongs.
Contains information about the impersonated user.
" - } - }, - "com.amazonaws.guardduty#InstanceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):[a-z]+:[a-z]+(-[0-9]+|-[a-z]+)+:([0-9]{12}):[a-z\\-]+\\/[a-zA-Z0-9]*$" - } - }, - "com.amazonaws.guardduty#InstanceDetails": { - "type": "structure", - "members": { - "AvailabilityZone": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Availability Zone of the EC2 instance.
", - "smithy.api#jsonName": "availabilityZone" - } - }, - "IamInstanceProfile": { - "target": "com.amazonaws.guardduty#IamInstanceProfile", - "traits": { - "smithy.api#documentation": "The profile information of the EC2 instance.
", - "smithy.api#jsonName": "iamInstanceProfile" - } - }, - "ImageDescription": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The image description of the EC2 instance.
", - "smithy.api#jsonName": "imageDescription" - } - }, - "ImageId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The image ID of the EC2 instance.
", - "smithy.api#jsonName": "imageId" - } - }, - "InstanceId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ID of the EC2 instance.
", - "smithy.api#jsonName": "instanceId" - } - }, - "InstanceState": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The state of the EC2 instance.
", - "smithy.api#jsonName": "instanceState" - } - }, - "InstanceType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The type of the EC2 instance.
", - "smithy.api#jsonName": "instanceType" - } - }, - "OutpostArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost. Only applicable to Amazon Web Services Outposts\n instances.
", - "smithy.api#jsonName": "outpostArn" - } - }, - "LaunchTime": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The launch time of the EC2 instance.
", - "smithy.api#jsonName": "launchTime" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.guardduty#NetworkInterfaces", - "traits": { - "smithy.api#documentation": "The elastic network interface information of the EC2 instance.
", - "smithy.api#jsonName": "networkInterfaces" - } - }, - "Platform": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The platform of the EC2 instance.
", - "smithy.api#jsonName": "platform" - } - }, - "ProductCodes": { - "target": "com.amazonaws.guardduty#ProductCodes", - "traits": { - "smithy.api#documentation": "The product code of the EC2 instance.
", - "smithy.api#jsonName": "productCodes" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "The tags of the EC2 instance.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the details of an instance.
" - } - }, - "com.amazonaws.guardduty#Integer": { - "type": "integer" - }, - "com.amazonaws.guardduty#IntegerValueWithMax": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#InternalServerErrorException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error message.
", - "smithy.api#jsonName": "message" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The error type.
", - "smithy.api#jsonName": "__type" - } - } - }, - "traits": { - "smithy.api#documentation": "An internal server error exception object.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.guardduty#Invitation": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "The ID of the account that the invitation was sent from.
", - "smithy.api#jsonName": "accountId" - } - }, - "InvitationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ID of the invitation. This value is used to validate the inviter account to the member\n account.
", - "smithy.api#jsonName": "invitationId" - } - }, - "RelationshipStatus": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The status of the relationship between the inviter and invitee accounts.
", - "smithy.api#jsonName": "relationshipStatus" - } - }, - "InvitedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The timestamp when the invitation was sent.
", - "smithy.api#jsonName": "invitedAt" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the invitation to become a member account.
" - } - }, - "com.amazonaws.guardduty#Invitations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Invitation" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#InviteMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#InviteMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#InviteMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using Amazon Web Services Organizations to manage your GuardDuty environment, this step is not\n needed. For more information, see Managing accounts with organizations.
\nTo invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/member/invite", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#InviteMembersRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty account that you want to invite members\n with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs of the accounts that you want to invite to GuardDuty as\n members.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - }, - "DisableEmailNotification": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "A Boolean value that specifies whether you want to disable email notification to the\n accounts that you are inviting to GuardDuty as members.
", - "smithy.api#jsonName": "disableEmailNotification" - } - }, - "Message": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The invitation message that you want to send to the accounts that you're inviting to\n GuardDuty as members.
", - "smithy.api#jsonName": "message" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#InviteMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#IpSetFormat": { - "type": "enum", - "members": { - "TXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TXT" - } - }, - "STIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STIX" - } - }, - "OTX_CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTX_CSV" - } - }, - "ALIEN_VAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALIEN_VAULT" - } - }, - "PROOF_POINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROOF_POINT" - } - }, - "FIRE_EYE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIRE_EYE" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#IpSetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#IpSetStatus": { - "type": "enum", - "members": { - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "ACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DEACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEACTIVATING" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "DELETE_PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_PENDING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#Ipv6Addresses": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Issues": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#KubernetesApiCallAction": { - "type": "structure", - "members": { - "RequestUri": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Kubernetes API request URI.
", - "smithy.api#jsonName": "requestUri" - } - }, - "Verb": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Kubernetes API request HTTP verb.
", - "smithy.api#jsonName": "verb" - } - }, - "SourceIps": { - "target": "com.amazonaws.guardduty#SourceIps", - "traits": { - "smithy.api#documentation": "The IP of the Kubernetes API caller and the IPs of any proxies or load balancers between\n the caller and the API endpoint.
", - "smithy.api#jsonName": "sourceIps" - } - }, - "UserAgent": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The user agent of the caller of the Kubernetes API.
", - "smithy.api#jsonName": "userAgent" - } - }, - "RemoteIpDetails": { - "target": "com.amazonaws.guardduty#RemoteIpDetails", - "traits": { - "smithy.api#jsonName": "remoteIpDetails" - } - }, - "StatusCode": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The resulting HTTP response code of the Kubernetes API call action.
", - "smithy.api#jsonName": "statusCode" - } - }, - "Parameters": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Parameters related to the Kubernetes API call action.
", - "smithy.api#jsonName": "parameters" - } - }, - "Resource": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The resource component in the Kubernetes API call action.
", - "smithy.api#jsonName": "resource" - } - }, - "Subresource": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the sub-resource in the Kubernetes API call action.
", - "smithy.api#jsonName": "subresource" - } - }, - "Namespace": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the namespace where the Kubernetes API call action takes place.
", - "smithy.api#jsonName": "namespace" - } - }, - "ResourceName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the resource in the Kubernetes API call action.
", - "smithy.api#jsonName": "resourceName" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the Kubernetes API call action described in this finding.
" - } - }, - "com.amazonaws.guardduty#KubernetesAuditLogsConfiguration": { - "type": "structure", - "members": { - "Enable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of Kubernetes audit logs as a data source.
", - "smithy.api#jsonName": "enable", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#KubernetesAuditLogsConfigurationResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.guardduty#DataSourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A value that describes whether Kubernetes audit logs are enabled as a data source.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#KubernetesConfiguration": { - "type": "structure", - "members": { - "AuditLogs": { - "target": "com.amazonaws.guardduty#KubernetesAuditLogsConfiguration", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of Kubernetes audit logs as a data source.
", - "smithy.api#jsonName": "auditLogs", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether any Kubernetes data sources are enabled.
" - } - }, - "com.amazonaws.guardduty#KubernetesConfigurationResult": { - "type": "structure", - "members": { - "AuditLogs": { - "target": "com.amazonaws.guardduty#KubernetesAuditLogsConfigurationResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
", - "smithy.api#jsonName": "auditLogs", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether any Kubernetes logs will be enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#KubernetesDataSourceFreeTrial": { - "type": "structure", - "members": { - "AuditLogs": { - "target": "com.amazonaws.guardduty#DataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether Kubernetes audit logs are enabled as a data source.
", - "smithy.api#jsonName": "auditLogs" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides details about the Kubernetes resources when it is enabled as a data\n source.
" - } - }, - "com.amazonaws.guardduty#KubernetesDetails": { - "type": "structure", - "members": { - "KubernetesUserDetails": { - "target": "com.amazonaws.guardduty#KubernetesUserDetails", - "traits": { - "smithy.api#documentation": "Details about the Kubernetes user involved in a Kubernetes finding.
", - "smithy.api#jsonName": "kubernetesUserDetails" - } - }, - "KubernetesWorkloadDetails": { - "target": "com.amazonaws.guardduty#KubernetesWorkloadDetails", - "traits": { - "smithy.api#documentation": "Details about the Kubernetes workload involved in a Kubernetes finding.
", - "smithy.api#jsonName": "kubernetesWorkloadDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about Kubernetes resources such as a Kubernetes user or workload resource involved\n in a Kubernetes finding.
" - } - }, - "com.amazonaws.guardduty#KubernetesPermissionCheckedDetails": { - "type": "structure", - "members": { - "Verb": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The verb component of the Kubernetes API call. For example, when you check whether or not you have the permission\n to call the CreatePod API, the verb component will be Create.
The Kubernetes resource with which your Kubernetes API call will interact.
", - "smithy.api#jsonName": "resource" - } - }, - "Namespace": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The namespace where the Kubernetes API action will take place.
", - "smithy.api#jsonName": "namespace" - } - }, - "Allowed": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Information whether the user has the permission to call the Kubernetes API.
", - "smithy.api#jsonName": "allowed" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the Kubernetes API for which you check if you have permission to call.
" - } - }, - "com.amazonaws.guardduty#KubernetesRoleBindingDetails": { - "type": "structure", - "members": { - "Kind": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The kind of the role. For role binding, this value will be RoleBinding.
The name of the RoleBinding.
The unique identifier of the role binding.
", - "smithy.api#jsonName": "uid" - } - }, - "RoleRefName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the role being referenced. This must match the name of the Role\n or ClusterRole that you want to bind to.
The type of the role being referenced. This could be either Role or \n ClusterRole.
Contains information about the role binding that grants the permission defined in a Kubernetes role.
" - } - }, - "com.amazonaws.guardduty#KubernetesRoleDetails": { - "type": "structure", - "members": { - "Kind": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The kind of role. For this API, the value of kind will be Role.
The name of the Kubernetes role.
", - "smithy.api#jsonName": "name" - } - }, - "Uid": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique identifier of the Kubernetes role name.
", - "smithy.api#jsonName": "uid" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the Kubernetes role name and role type.
" - } - }, - "com.amazonaws.guardduty#KubernetesUserDetails": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The username of the user who called the Kubernetes API.
", - "smithy.api#jsonName": "username" - } - }, - "Uid": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The user ID of the user who called the Kubernetes API.
", - "smithy.api#jsonName": "uid" - } - }, - "Groups": { - "target": "com.amazonaws.guardduty#Groups", - "traits": { - "smithy.api#documentation": "The groups that include the user who called the Kubernetes API.
", - "smithy.api#jsonName": "groups" - } - }, - "SessionName": { - "target": "com.amazonaws.guardduty#SessionNameList", - "traits": { - "smithy.api#documentation": "Entity that assumes the IAM role \n when Kubernetes RBAC permissions are assigned to that role.
", - "smithy.api#jsonName": "sessionName" - } - }, - "ImpersonatedUser": { - "target": "com.amazonaws.guardduty#ImpersonatedUser", - "traits": { - "smithy.api#documentation": "Information about the impersonated user.
", - "smithy.api#jsonName": "impersonatedUser" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the Kubernetes user involved in a Kubernetes finding.
" - } - }, - "com.amazonaws.guardduty#KubernetesWorkloadDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Kubernetes workload name.
", - "smithy.api#jsonName": "name" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Kubernetes workload type (e.g. Pod, Deployment, etc.).
", - "smithy.api#jsonName": "type" - } - }, - "Uid": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Kubernetes workload ID.
", - "smithy.api#jsonName": "uid" - } - }, - "Namespace": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Kubernetes namespace that the workload is part of.
", - "smithy.api#jsonName": "namespace" - } - }, - "HostNetwork": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Whether the hostNetwork flag is enabled for the pods included in the workload.
", - "smithy.api#jsonName": "hostNetwork" - } - }, - "Containers": { - "target": "com.amazonaws.guardduty#Containers", - "traits": { - "smithy.api#documentation": "Containers running as part of the Kubernetes workload.
", - "smithy.api#jsonName": "containers" - } - }, - "Volumes": { - "target": "com.amazonaws.guardduty#Volumes", - "traits": { - "smithy.api#documentation": "Volumes used by the Kubernetes workload.
", - "smithy.api#jsonName": "volumes" - } - }, - "ServiceAccountName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The service account name that is associated with a Kubernetes workload.
", - "smithy.api#jsonName": "serviceAccountName" - } - }, - "HostIPC": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Whether the host IPC flag is enabled for the pods in the workload.
", - "smithy.api#jsonName": "hostIPC" - } - }, - "HostPID": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Whether the host PID flag is enabled for the pods in the workload.
", - "smithy.api#jsonName": "hostPID" - } - } - }, - "traits": { - "smithy.api#documentation": "Details about the Kubernetes workload involved in a Kubernetes finding.
" - } - }, - "com.amazonaws.guardduty#LambdaDetails": { - "type": "structure", - "members": { - "FunctionArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) of the Lambda function.
", - "smithy.api#jsonName": "functionArn" - } - }, - "FunctionName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Name of the Lambda function.
", - "smithy.api#jsonName": "functionName" - } - }, - "Description": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Description of the Lambda function.
", - "smithy.api#jsonName": "description" - } - }, - "LastModifiedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp when the Lambda function was last modified. This field is in the UTC date string \n format (2023-03-22T19:37:20.168Z).
The revision ID of the Lambda function version.
", - "smithy.api#jsonName": "revisionId" - } - }, - "FunctionVersion": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The version of the Lambda function.
", - "smithy.api#jsonName": "functionVersion" - } - }, - "Role": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The execution role of the Lambda function.
", - "smithy.api#jsonName": "role" - } - }, - "VpcConfig": { - "target": "com.amazonaws.guardduty#VpcConfig", - "traits": { - "smithy.api#documentation": "Amazon Virtual Private Cloud configuration details associated with your Lambda function.
", - "smithy.api#jsonName": "vpcConfig" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "A list of tags attached to this resource, listed in the format of \n key:value pair.
Information about the Lambda function involved in the finding.
" - } - }, - "com.amazonaws.guardduty#Lineage": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#LineageObject" - } - }, - "com.amazonaws.guardduty#LineageObject": { - "type": "structure", - "members": { - "StartTime": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the process started. This is in UTC format.
", - "smithy.api#jsonName": "startTime" - } - }, - "NamespacePid": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The process ID of the child process.
", - "smithy.api#jsonName": "namespacePid" - } - }, - "UserId": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The user ID of the user that executed the process.
", - "smithy.api#jsonName": "userId" - } - }, - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the process.
", - "smithy.api#jsonName": "name" - } - }, - "Pid": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The ID of the process.
", - "smithy.api#jsonName": "pid" - } - }, - "Uuid": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID assigned to the process by GuardDuty.
", - "smithy.api#jsonName": "uuid" - } - }, - "ExecutablePath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The absolute path of the process executable file.
", - "smithy.api#jsonName": "executablePath" - } - }, - "Euid": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The effective user ID that was used to execute the process.
", - "smithy.api#jsonName": "euid" - } - }, - "ParentUuid": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID of the parent process. This ID is assigned to the parent process by\n GuardDuty.
", - "smithy.api#jsonName": "parentUuid" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the runtime process details.
" - } - }, - "com.amazonaws.guardduty#ListCoverage": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListCoverageRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListCoverageResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists coverage details for your GuardDuty account. If you're a GuardDuty administrator, you can\n retrieve all resources associated with the active member accounts in your organization.
\nMake sure the accounts have EKS Runtime Monitoring enabled and GuardDuty agent running on\n their EKS nodes.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/coverage", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Resources", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListCoverageRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector whose coverage details you want to retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results after the first\n page.
", - "smithy.api#jsonName": "nextToken" - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response.
", - "smithy.api#jsonName": "maxResults" - } - }, - "FilterCriteria": { - "target": "com.amazonaws.guardduty#CoverageFilterCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria used to filter the coverage details.
", - "smithy.api#jsonName": "filterCriteria" - } - }, - "SortCriteria": { - "target": "com.amazonaws.guardduty#CoverageSortCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria used to sort the coverage details.
", - "smithy.api#jsonName": "sortCriteria" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListCoverageResponse": { - "type": "structure", - "members": { - "Resources": { - "target": "com.amazonaws.guardduty#CoverageResources", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of resources and their attributes providing cluster details.
", - "smithy.api#jsonName": "resources", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListDetectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListDetectorsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListDetectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists detectorIds of all the existing Amazon GuardDuty detector resources.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DetectorIds", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListDetectorsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListDetectorsResponse": { - "type": "structure", - "members": { - "DetectorIds": { - "target": "com.amazonaws.guardduty#DetectorIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of detector IDs.
", - "smithy.api#jsonName": "detectorIds", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListFilters": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListFiltersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListFiltersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a paginated list of the current filters.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/filter", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FilterNames", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListFiltersRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the filter is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListFiltersResponse": { - "type": "structure", - "members": { - "FilterNames": { - "target": "com.amazonaws.guardduty#FilterNames", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of filter names.
", - "smithy.api#jsonName": "filterNames", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListFindingsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists Amazon GuardDuty findings for the specified detector ID.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/findings", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FindingIds", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListFindingsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector that specifies the GuardDuty service whose findings you want to\n list.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FindingCriteria": { - "target": "com.amazonaws.guardduty#FindingCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria used for querying findings. Valid values include:
\nJSON field name
\naccountId
\nregion
\nconfidence
\nid
\nresource.accessKeyDetails.accessKeyId
\nresource.accessKeyDetails.principalId
\nresource.accessKeyDetails.userName
\nresource.accessKeyDetails.userType
\nresource.instanceDetails.iamInstanceProfile.id
\nresource.instanceDetails.imageId
\nresource.instanceDetails.instanceId
\nresource.instanceDetails.networkInterfaces.ipv6Addresses
\nresource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
\nresource.instanceDetails.networkInterfaces.publicDnsName
\nresource.instanceDetails.networkInterfaces.publicIp
\nresource.instanceDetails.networkInterfaces.securityGroups.groupId
\nresource.instanceDetails.networkInterfaces.securityGroups.groupName
\nresource.instanceDetails.networkInterfaces.subnetId
\nresource.instanceDetails.networkInterfaces.vpcId
\nresource.instanceDetails.tags.key
\nresource.instanceDetails.tags.value
\nresource.resourceType
\nservice.action.actionType
\nservice.action.awsApiCallAction.api
\nservice.action.awsApiCallAction.callerType
\nservice.action.awsApiCallAction.remoteIpDetails.city.cityName
\nservice.action.awsApiCallAction.remoteIpDetails.country.countryName
\nservice.action.awsApiCallAction.remoteIpDetails.ipAddressV4
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asn
\nservice.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
\nservice.action.awsApiCallAction.serviceName
\nservice.action.dnsRequestAction.domain
\nservice.action.dnsRequestAction.domainWithSuffix
\nservice.action.networkConnectionAction.blocked
\nservice.action.networkConnectionAction.connectionDirection
\nservice.action.networkConnectionAction.localPortDetails.port
\nservice.action.networkConnectionAction.protocol
\nservice.action.networkConnectionAction.remoteIpDetails.country.countryName
\nservice.action.networkConnectionAction.remoteIpDetails.ipAddressV4
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asn
\nservice.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
\nservice.action.networkConnectionAction.remotePortDetails.port
\nservice.additionalInfo.threatListName
\nservice.archived
\nWhen this attribute is set to 'true', only archived findings are listed. When it's set\n to 'false', only unarchived findings are listed. When this attribute is not set, all\n existing findings are listed.
\nservice.resourceRole
\nseverity
\ntype
\nupdatedAt
\nType: Timestamp in Unix Epoch millisecond format: 1486685375000
\nRepresents the criteria used for sorting findings.
", - "smithy.api#jsonName": "sortCriteria" - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListFindingsResponse": { - "type": "structure", - "members": { - "FindingIds": { - "target": "com.amazonaws.guardduty#FindingIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the findings that you're listing.
", - "smithy.api#jsonName": "findingIds", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListIPSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListIPSetsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListIPSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this\n operation from a member account, the IPSets returned are the IPSets from the associated\n administrator account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/ipset", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IpSetIds", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListIPSetsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the IPSet is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListIPSetsResponse": { - "type": "structure", - "members": { - "IpSetIds": { - "target": "com.amazonaws.guardduty#IpSetIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the IPSet resources.
", - "smithy.api#jsonName": "ipSetIds", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListInvitations": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListInvitationsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListInvitationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all GuardDuty membership invitations that were sent to the current Amazon Web Services\n account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/invitation", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Invitations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListInvitationsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListInvitationsResponse": { - "type": "structure", - "members": { - "Invitations": { - "target": "com.amazonaws.guardduty#Invitations", - "traits": { - "smithy.api#documentation": "A list of invitation descriptions.
", - "smithy.api#jsonName": "invitations" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists details about all member accounts for the current GuardDuty administrator\n account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/member", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Members", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListMembersRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector the member is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter when paginating results. Set the value of this parameter to\n null on your first call to the list action. For subsequent calls to the action, fill nextToken\n in the request with the value of NextToken from the previous response to continue listing\n data.
", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - }, - "OnlyAssociated": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Specifies whether to only return associated members or to return all members (including\n members who haven't been invited yet or have been disassociated). Member accounts must have\n been previously associated with the GuardDuty administrator account using \n Create\n Members\n .
A list of members.
\nThe values for email and invitedAt are available\n only if the member accounts are added by invitation.
The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListOrganizationAdminAccounts": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListOrganizationAdminAccountsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListOrganizationAdminAccountsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the accounts designated as GuardDuty delegated administrators. \n Only the organization's management account can run this \n API operation.
", - "smithy.api#http": { - "method": "GET", - "uri": "/admin", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AdminAccounts", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListOrganizationAdminAccountsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.
A list of accounts configured as GuardDuty delegated administrators.
", - "smithy.api#jsonName": "adminAccounts" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListPublishingDestinations": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListPublishingDestinationsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListPublishingDestinationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of publishing destinations associated with the specified\n detectorId.
The ID of the detector to retrieve publishing destinations for.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to return in the response.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.
A Destinations object that includes information about each publishing\n destination returned.
A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request to a list action. For subsequent calls, use the\n NextToken value returned from the previous request to continue listing results\n after the first page.
Lists tags for a resource. Tagging is currently supported for detectors, finding filters,\n IP sets, threat intel sets, and publishing destination, with a limit of 50 tags per resource. \n When invoked, this\n operation returns all assigned tags for a given resource.
", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.guardduty#GuardDutyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the given GuardDuty resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "resourceArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#documentation": "The tags associated with the resource.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#ListThreatIntelSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#ListThreatIntelSetsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#ListThreatIntelSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you\n use this operation from a member account, the ThreatIntelSets associated with the\n administrator account are returned.
", - "smithy.api#http": { - "method": "GET", - "uri": "/detector/{DetectorId}/threatintelset", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ThreatIntelSetIds", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.guardduty#ListThreatIntelSetsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the threatIntelSet is associated with.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.guardduty#MaxResults", - "traits": { - "smithy.api#documentation": "You can use this parameter to indicate the maximum number of items that you want in the\n response. The default value is 50. The maximum value is 50.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#jsonName": "maxResults" - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "You can use this parameter to paginate results in the response. Set the value of this\n parameter to null on your first call to the list action. For subsequent calls to the action,\n fill nextToken in the request with the value of NextToken from the previous response to\n continue listing data.
", - "smithy.api#httpQuery": "nextToken", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#ListThreatIntelSetsResponse": { - "type": "structure", - "members": { - "ThreatIntelSetIds": { - "target": "com.amazonaws.guardduty#ThreatIntelSetIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the ThreatIntelSet resources.
", - "smithy.api#jsonName": "threatIntelSetIds", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The pagination parameter to be used on the next list operation to retrieve more\n items.
", - "smithy.api#jsonName": "nextToken" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#LocalIpDetails": { - "type": "structure", - "members": { - "IpAddressV4": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The IPv4 local address of the connection.
", - "smithy.api#jsonName": "ipAddressV4" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the local IP address of the connection.
" - } - }, - "com.amazonaws.guardduty#LocalPortDetails": { - "type": "structure", - "members": { - "Port": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The port number of the local connection.
", - "smithy.api#jsonName": "port" - } - }, - "PortName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The port name of the local connection.
", - "smithy.api#jsonName": "portName" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the port for the local connection.
" - } - }, - "com.amazonaws.guardduty#Location": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#LoginAttribute": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Indicates the user name which attempted to log in.
", - "smithy.api#jsonName": "user" - } - }, - "Application": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Indicates the application name used to attempt log in.
", - "smithy.api#jsonName": "application" - } - }, - "FailedLoginAttempts": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Represents the sum of failed (unsuccessful) login attempts made to establish a connection\n to the database instance.
", - "smithy.api#jsonName": "failedLoginAttempts" - } - }, - "SuccessfulLoginAttempts": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Represents the sum of successful connections (a correct combination of login attributes)\n made to the database instance by the actor.
", - "smithy.api#jsonName": "successfulLoginAttempts" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the login attempts.
" - } - }, - "com.amazonaws.guardduty#LoginAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#LoginAttribute" - } - }, - "com.amazonaws.guardduty#Long": { - "type": "long" - }, - "com.amazonaws.guardduty#LongValue": { - "type": "long" - }, - "com.amazonaws.guardduty#MalwareProtectionConfiguration": { - "type": "structure", - "members": { - "ScanEc2InstanceWithFindings": { - "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindings", - "traits": { - "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", - "smithy.api#jsonName": "scanEc2InstanceWithFindings" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether Malware Protection will be enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#MalwareProtectionConfigurationResult": { - "type": "structure", - "members": { - "ScanEc2InstanceWithFindings": { - "target": "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult", - "traits": { - "smithy.api#documentation": "Describes the configuration of Malware Protection for EC2 instances with findings.
", - "smithy.api#jsonName": "scanEc2InstanceWithFindings" - } - }, - "ServiceRole": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The GuardDuty Malware Protection service role.
", - "smithy.api#jsonName": "serviceRole" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data\n sources.
" - } - }, - "com.amazonaws.guardduty#MalwareProtectionDataSourceFreeTrial": { - "type": "structure", - "members": { - "ScanEc2InstanceWithFindings": { - "target": "com.amazonaws.guardduty#DataSourceFreeTrial", - "traits": { - "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings is enabled as a data\n source.
", - "smithy.api#jsonName": "scanEc2InstanceWithFindings" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides details about Malware Protection when it is enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#ManagementType": { - "type": "enum", - "members": { - "AUTO_MANAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_MANAGED" - } - }, - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.guardduty#MapEquals": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#ScanConditionPair" - } - }, - "com.amazonaws.guardduty#Master": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "The ID of the account used as the administrator account.
", - "smithy.api#jsonName": "accountId" - } - }, - "InvitationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The value used to validate the administrator account to the member account.
", - "smithy.api#jsonName": "invitationId" - } - }, - "RelationshipStatus": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The status of the relationship between the administrator and member accounts.
", - "smithy.api#jsonName": "relationshipStatus" - } - }, - "InvitedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The timestamp when the invitation was sent.
", - "smithy.api#jsonName": "invitedAt" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the administrator account and invitation.
" - } - }, - "com.amazonaws.guardduty#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#Member": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the member account.
", - "smithy.api#jsonName": "accountId", - "smithy.api#required": {} - } - }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The detector ID of the member account.
", - "smithy.api#jsonName": "detectorId" - } - }, - "MasterId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The administrator account ID.
", - "smithy.api#jsonName": "masterId", - "smithy.api#required": {} - } - }, - "Email": { - "target": "com.amazonaws.guardduty#Email", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The email address of the member account.
", - "smithy.api#jsonName": "email", - "smithy.api#required": {} - } - }, - "RelationshipStatus": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of the relationship between the member and the administrator.
", - "smithy.api#jsonName": "relationshipStatus", - "smithy.api#required": {} - } - }, - "InvitedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The timestamp when the invitation was sent.
", - "smithy.api#jsonName": "invitedAt" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The last-updated timestamp of the member.
", - "smithy.api#jsonName": "updatedAt", - "smithy.api#required": {} - } - }, - "AdministratorId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The administrator account ID.
", - "smithy.api#jsonName": "administratorId" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the member account.
" - } - }, - "com.amazonaws.guardduty#MemberAdditionalConfiguration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", - "traits": { - "smithy.api#documentation": "Name of the additional configuration.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "Status of the additional configuration.
", - "smithy.api#jsonName": "status" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the additional configuration for the member account.
" - } - }, - "com.amazonaws.guardduty#MemberAdditionalConfigurationResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", - "traits": { - "smithy.api#documentation": "Indicates the name of the additional configuration that is set for the member\n account.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the additional configuration that is set for the member\n account.
", - "smithy.api#jsonName": "status" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the additional configuration was set for the member account. This\n is in UTC format.
", - "smithy.api#jsonName": "updatedAt" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the additional configuration for the member account.
" - } - }, - "com.amazonaws.guardduty#MemberAdditionalConfigurationResults": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#MemberAdditionalConfigurationResult" - } - }, - "com.amazonaws.guardduty#MemberAdditionalConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#MemberAdditionalConfiguration" - } - }, - "com.amazonaws.guardduty#MemberDataSourceConfiguration": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The account ID for the member account.
", - "smithy.api#jsonName": "accountId", - "smithy.api#required": {} - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurationsResult", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "Contains information on the status of data sources for the account.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#MemberFeaturesConfigurationsResults", - "traits": { - "smithy.api#documentation": "Contains information about the status of the features for the member account.
", - "smithy.api#jsonName": "features" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on which data sources are enabled for a member account.
" - } - }, - "com.amazonaws.guardduty#MemberDataSourceConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#MemberDataSourceConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#MemberFeaturesConfiguration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeature", - "traits": { - "smithy.api#documentation": "The name of the feature.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "The status of the feature.
", - "smithy.api#jsonName": "status" - } - }, - "AdditionalConfiguration": { - "target": "com.amazonaws.guardduty#MemberAdditionalConfigurations", - "traits": { - "smithy.api#documentation": "Additional configuration of the feature for the member account.
", - "smithy.api#jsonName": "additionalConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the features for the member account.
" - } - }, - "com.amazonaws.guardduty#MemberFeaturesConfigurationResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeature", - "traits": { - "smithy.api#documentation": "Indicates the name of the feature that is enabled for the detector.
", - "smithy.api#jsonName": "name" - } - }, - "Status": { - "target": "com.amazonaws.guardduty#FeatureStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the feature that is enabled for the detector.
", - "smithy.api#jsonName": "status" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the feature object was updated.
", - "smithy.api#jsonName": "updatedAt" - } - }, - "AdditionalConfiguration": { - "target": "com.amazonaws.guardduty#MemberAdditionalConfigurationResults", - "traits": { - "smithy.api#documentation": "Indicates the additional configuration of the feature that is configured for the member\n account.
", - "smithy.api#jsonName": "additionalConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the features for the member account.
" - } - }, - "com.amazonaws.guardduty#MemberFeaturesConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#MemberFeaturesConfiguration" - } - }, - "com.amazonaws.guardduty#MemberFeaturesConfigurationsResults": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#MemberFeaturesConfigurationResult" - } - }, - "com.amazonaws.guardduty#Members": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Member" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#MemoryRegionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#Neq": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#NetworkConnectionAction": { - "type": "structure", - "members": { - "Blocked": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether EC2 blocked the network connection to your instance.
", - "smithy.api#jsonName": "blocked" - } - }, - "ConnectionDirection": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The network connection direction.
", - "smithy.api#jsonName": "connectionDirection" - } - }, - "LocalPortDetails": { - "target": "com.amazonaws.guardduty#LocalPortDetails", - "traits": { - "smithy.api#documentation": "The local port information of the connection.
", - "smithy.api#jsonName": "localPortDetails" - } - }, - "Protocol": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The network connection protocol.
", - "smithy.api#jsonName": "protocol" - } - }, - "LocalIpDetails": { - "target": "com.amazonaws.guardduty#LocalIpDetails", - "traits": { - "smithy.api#documentation": "The local IP information of the connection.
", - "smithy.api#jsonName": "localIpDetails" - } - }, - "RemoteIpDetails": { - "target": "com.amazonaws.guardduty#RemoteIpDetails", - "traits": { - "smithy.api#documentation": "The remote IP information of the connection.
", - "smithy.api#jsonName": "remoteIpDetails" - } - }, - "RemotePortDetails": { - "target": "com.amazonaws.guardduty#RemotePortDetails", - "traits": { - "smithy.api#documentation": "The remote port information of the connection.
", - "smithy.api#jsonName": "remotePortDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the NETWORK_CONNECTION action described in the finding.
" - } - }, - "com.amazonaws.guardduty#NetworkInterface": { - "type": "structure", - "members": { - "Ipv6Addresses": { - "target": "com.amazonaws.guardduty#Ipv6Addresses", - "traits": { - "smithy.api#documentation": "A list of IPv6 addresses for the EC2 instance.
", - "smithy.api#jsonName": "ipv6Addresses" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ID of the network interface.
", - "smithy.api#jsonName": "networkInterfaceId" - } - }, - "PrivateDnsName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The private DNS name of the EC2 instance.
", - "smithy.api#jsonName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The private IP address of the EC2 instance.
", - "smithy.api#jsonName": "privateIpAddress" - } - }, - "PrivateIpAddresses": { - "target": "com.amazonaws.guardduty#PrivateIpAddresses", - "traits": { - "smithy.api#documentation": "Other private IP address information of the EC2 instance.
", - "smithy.api#jsonName": "privateIpAddresses" - } - }, - "PublicDnsName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The public DNS name of the EC2 instance.
", - "smithy.api#jsonName": "publicDnsName" - } - }, - "PublicIp": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The public IP address of the EC2 instance.
", - "smithy.api#jsonName": "publicIp" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.guardduty#SecurityGroups", - "traits": { - "smithy.api#documentation": "The security groups associated with the EC2 instance.
", - "smithy.api#jsonName": "securityGroups" - } - }, - "SubnetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The subnet ID of the EC2 instance.
", - "smithy.api#jsonName": "subnetId" - } - }, - "VpcId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The VPC ID of the EC2 instance.
", - "smithy.api#jsonName": "vpcId" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the elastic network interface of the EC2 instance.
" - } - }, - "com.amazonaws.guardduty#NetworkInterfaces": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#NetworkInterface" - } - }, - "com.amazonaws.guardduty#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.guardduty#NotEquals": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#ObservationTexts": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Observations": { - "type": "structure", - "members": { - "Text": { - "target": "com.amazonaws.guardduty#ObservationTexts", - "traits": { - "smithy.api#documentation": "The text that was unusual.
", - "smithy.api#jsonName": "text" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the observed behavior.
" - } - }, - "com.amazonaws.guardduty#OrderBy": { - "type": "enum", - "members": { - "ASC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASC" - } - }, - "DESC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESC" - } - } - } - }, - "com.amazonaws.guardduty#OrgFeature": { - "type": "enum", - "members": { - "S3_DATA_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_DATA_EVENTS" - } - }, - "EKS_AUDIT_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_AUDIT_LOGS" - } - }, - "EBS_MALWARE_PROTECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" - } - }, - "RDS_LOGIN_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_LOGIN_EVENTS" - } - }, - "EKS_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" - } - }, - "LAMBDA_NETWORK_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" - } - }, - "RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNTIME_MONITORING" - } - } - } - }, - "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration": { - "type": "enum", - "members": { - "EKS_ADDON_MANAGEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_ADDON_MANAGEMENT" - } - }, - "ECS_FARGATE_AGENT_MANAGEMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECS_FARGATE_AGENT_MANAGEMENT" - } - } - } - }, - "com.amazonaws.guardduty#OrgFeatureStatus": { - "type": "enum", - "members": { - "NEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } - }, - "com.amazonaws.guardduty#Organization": { - "type": "structure", - "members": { - "Asn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Autonomous System Number (ASN) of the internet provider of the remote IP\n address.
", - "smithy.api#jsonName": "asn" - } - }, - "AsnOrg": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The organization that registered this ASN.
", - "smithy.api#jsonName": "asnOrg" - } - }, - "Isp": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ISP information for the internet provider.
", - "smithy.api#jsonName": "isp" - } - }, - "Org": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the internet provider.
", - "smithy.api#jsonName": "org" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the ISP organization of the remote IP address.
" - } - }, - "com.amazonaws.guardduty#OrganizationAdditionalConfiguration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", - "traits": { - "smithy.api#documentation": "The name of the additional configuration that will be configured for the\n organization.
", - "smithy.api#jsonName": "name" - } - }, - "AutoEnable": { - "target": "com.amazonaws.guardduty#OrgFeatureStatus", - "traits": { - "smithy.api#documentation": "The status of the additional configuration that will be configured for the\n organization. Use one of the following \n values to configure the feature status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the additional configuration enabled automatically.
\n ALL: Indicates that all accounts in the organization have \n the additional configuration\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the additional configuration will not be \n automatically enabled for any\n account in the organization. The administrator must manage the additional configuration \n for each account individually.
A list of additional configurations which will be configured for the organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeatureAdditionalConfiguration", - "traits": { - "smithy.api#documentation": "The name of the additional configuration that is configured for the member accounts within\n the organization.
", - "smithy.api#jsonName": "name" - } - }, - "AutoEnable": { - "target": "com.amazonaws.guardduty#OrgFeatureStatus", - "traits": { - "smithy.api#documentation": "Describes the status of the additional configuration that is configured for the\n member accounts within the organization. One of the following \n values is the status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the additional configuration enabled automatically.
\n ALL: Indicates that all accounts in the organization have \n the additional configuration\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the additional configuration will not be \n automatically enabled for any\n account in the organization. The administrator must manage the additional configuration \n for each account individually.
A list of additional configuration which will be configured for the organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResults": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#OrganizationAdditionalConfigurationResult" - } - }, - "com.amazonaws.guardduty#OrganizationAdditionalConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#OrganizationAdditionalConfiguration" - } - }, - "com.amazonaws.guardduty#OrganizationDataSourceConfigurations": { - "type": "structure", - "members": { - "S3Logs": { - "target": "com.amazonaws.guardduty#OrganizationS3LogsConfiguration", - "traits": { - "smithy.api#documentation": "Describes whether S3 data event logs are enabled for new members of the\n organization.
", - "smithy.api#jsonName": "s3Logs" - } - }, - "Kubernetes": { - "target": "com.amazonaws.guardduty#OrganizationKubernetesConfiguration", - "traits": { - "smithy.api#documentation": "Describes the configuration of Kubernetes data sources for new members of the\n organization.
", - "smithy.api#jsonName": "kubernetes" - } - }, - "MalwareProtection": { - "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration", - "traits": { - "smithy.api#documentation": "Describes the configuration of Malware Protection for new members of the\n organization.
", - "smithy.api#jsonName": "malwareProtection" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains information on which data sources will be configured to be\n automatically enabled for new members within the organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationDataSourceConfigurationsResult": { - "type": "structure", - "members": { - "S3Logs": { - "target": "com.amazonaws.guardduty#OrganizationS3LogsConfigurationResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Describes whether S3 data event logs are enabled as a data source.
", - "smithy.api#jsonName": "s3Logs", - "smithy.api#required": {} - } - }, - "Kubernetes": { - "target": "com.amazonaws.guardduty#OrganizationKubernetesConfigurationResult", - "traits": { - "smithy.api#documentation": "Describes the configuration of Kubernetes data sources.
", - "smithy.api#jsonName": "kubernetes" - } - }, - "MalwareProtection": { - "target": "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult", - "traits": { - "smithy.api#documentation": "Describes the configuration of Malware Protection data source for an organization.
", - "smithy.api#jsonName": "malwareProtection" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains information on which data sources are automatically enabled for\n new members within the organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationEbsVolumes": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the\n organization.
", - "smithy.api#jsonName": "autoEnable" - } - } - }, - "traits": { - "smithy.api#documentation": "Organization-wide EBS volumes scan configuration.
" - } - }, - "com.amazonaws.guardduty#OrganizationEbsVolumesResult": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "An object that contains the status of whether scanning EBS volumes should be auto-enabled\n for new members joining the organization.
", - "smithy.api#jsonName": "autoEnable" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains information on the status of whether EBS volumes scanning will be\n enabled as a data source for an organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationFeatureConfiguration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeature", - "traits": { - "smithy.api#documentation": "The name of the feature that will be configured for the organization.
", - "smithy.api#jsonName": "name" - } - }, - "AutoEnable": { - "target": "com.amazonaws.guardduty#OrgFeatureStatus", - "traits": { - "smithy.api#documentation": "Describes the status of the feature that is configured for the\n member accounts within the organization. One of the following \n values is the status for the entire organization:
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that the feature will not be \n automatically enabled for any\n account in the organization. The administrator must manage the feature\n for each account individually.
The additional information that will be configured for the organization.
", - "smithy.api#jsonName": "additionalConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of features which will be configured for the organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationFeatureConfigurationResult": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#OrgFeature", - "traits": { - "smithy.api#documentation": "The name of the feature that is configured for the member accounts within the\n organization.
", - "smithy.api#jsonName": "name" - } - }, - "AutoEnable": { - "target": "com.amazonaws.guardduty#OrgFeatureStatus", - "traits": { - "smithy.api#documentation": "Describes the status of the feature that is configured for the member accounts within\n the organization.
\n\n NEW: Indicates that when a new account joins the organization, they will\n have the feature enabled automatically.
\n ALL: Indicates that all accounts in the organization have the feature \n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
\n NONE: Indicates that the feature will not be automatically enabled for any\n account in the organization. In this case, each account will be managed individually \n by the\n administrator.
The additional configuration that is configured for the member accounts within the\n organization.
", - "smithy.api#jsonName": "additionalConfiguration" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of features which will be configured for the organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationFeaturesConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#OrganizationFeatureConfiguration" - } - }, - "com.amazonaws.guardduty#OrganizationFeaturesConfigurationsResults": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#OrganizationFeatureConfigurationResult" - } - }, - "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfiguration": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A value that contains information on whether Kubernetes audit logs should be enabled\n automatically as a data source for the organization.
", - "smithy.api#jsonName": "autoEnable", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Organization-wide Kubernetes audit logs configuration.
" - } - }, - "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfigurationResult": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether Kubernetes audit logs data source should be auto-enabled for new members joining\n the organization.
", - "smithy.api#jsonName": "autoEnable", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The current configuration of Kubernetes audit logs as a data source for the\n organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationKubernetesConfiguration": { - "type": "structure", - "members": { - "AuditLogs": { - "target": "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfiguration", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Whether Kubernetes audit logs data source should be auto-enabled for new members joining\n the organization.
", - "smithy.api#jsonName": "auditLogs", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Organization-wide Kubernetes data sources configurations.
" - } - }, - "com.amazonaws.guardduty#OrganizationKubernetesConfigurationResult": { - "type": "structure", - "members": { - "AuditLogs": { - "target": "com.amazonaws.guardduty#OrganizationKubernetesAuditLogsConfigurationResult", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The current configuration of Kubernetes audit logs as a data source for the\n organization.
", - "smithy.api#jsonName": "auditLogs", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The current configuration of all Kubernetes data sources for the organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationMalwareProtectionConfiguration": { - "type": "structure", - "members": { - "ScanEc2InstanceWithFindings": { - "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings", - "traits": { - "smithy.api#documentation": "Whether Malware Protection for EC2 instances with findings should be auto-enabled for new\n members joining the organization.
", - "smithy.api#jsonName": "scanEc2InstanceWithFindings" - } - } - }, - "traits": { - "smithy.api#documentation": "Organization-wide Malware Protection configurations.
" - } - }, - "com.amazonaws.guardduty#OrganizationMalwareProtectionConfigurationResult": { - "type": "structure", - "members": { - "ScanEc2InstanceWithFindings": { - "target": "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult", - "traits": { - "smithy.api#documentation": "Describes the configuration for scanning EC2 instances with findings for an\n organization.
", - "smithy.api#jsonName": "scanEc2InstanceWithFindings" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains information on the status of all Malware Protection data source\n for an organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationS3LogsConfiguration": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A value that contains information on whether S3 data event logs will be enabled\n automatically as a data source for the organization.
", - "smithy.api#jsonName": "autoEnable", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether S3 data event logs will be automatically enabled for new members of the\n organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationS3LogsConfigurationResult": { - "type": "structure", - "members": { - "AutoEnable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new\n members of the organization.
", - "smithy.api#jsonName": "autoEnable", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The current configuration of S3 data event logs as a data source for the\n organization.
" - } - }, - "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindings": { - "type": "structure", - "members": { - "EbsVolumes": { - "target": "com.amazonaws.guardduty#OrganizationEbsVolumes", - "traits": { - "smithy.api#documentation": "Whether scanning EBS volumes should be auto-enabled for new members joining the\n organization.
", - "smithy.api#jsonName": "ebsVolumes" - } - } - }, - "traits": { - "smithy.api#documentation": "Organization-wide EC2 instances with findings scan configuration.
" - } - }, - "com.amazonaws.guardduty#OrganizationScanEc2InstanceWithFindingsResult": { - "type": "structure", - "members": { - "EbsVolumes": { - "target": "com.amazonaws.guardduty#OrganizationEbsVolumesResult", - "traits": { - "smithy.api#documentation": "Describes the configuration for scanning EBS volumes for an organization.
", - "smithy.api#jsonName": "ebsVolumes" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains information on the status of scanning EC2 instances with findings\n for an organization.
" - } - }, - "com.amazonaws.guardduty#Owner": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The canonical user ID of the bucket owner. For information about locating your canonical\n user ID see Finding Your Account\n Canonical User ID.\n
", - "smithy.api#jsonName": "id" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the owner of the bucket.
" - } - }, - "com.amazonaws.guardduty#PermissionConfiguration": { - "type": "structure", - "members": { - "BucketLevelPermissions": { - "target": "com.amazonaws.guardduty#BucketLevelPermissions", - "traits": { - "smithy.api#documentation": "Contains information about the bucket level permissions for the S3 bucket.
", - "smithy.api#jsonName": "bucketLevelPermissions" - } - }, - "AccountLevelPermissions": { - "target": "com.amazonaws.guardduty#AccountLevelPermissions", - "traits": { - "smithy.api#documentation": "Contains information about the account level permissions on the S3 bucket.
", - "smithy.api#jsonName": "accountLevelPermissions" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about how permissions are configured for the S3 bucket.
" - } - }, - "com.amazonaws.guardduty#PortProbeAction": { - "type": "structure", - "members": { - "Blocked": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.
", - "smithy.api#jsonName": "blocked" - } - }, - "PortProbeDetails": { - "target": "com.amazonaws.guardduty#PortProbeDetails", - "traits": { - "smithy.api#documentation": "A list of objects related to port probe details.
", - "smithy.api#jsonName": "portProbeDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the PORT_PROBE action described in the finding.
" - } - }, - "com.amazonaws.guardduty#PortProbeDetail": { - "type": "structure", - "members": { - "LocalPortDetails": { - "target": "com.amazonaws.guardduty#LocalPortDetails", - "traits": { - "smithy.api#documentation": "The local port information of the connection.
", - "smithy.api#jsonName": "localPortDetails" - } - }, - "LocalIpDetails": { - "target": "com.amazonaws.guardduty#LocalIpDetails", - "traits": { - "smithy.api#documentation": "The local IP information of the connection.
", - "smithy.api#jsonName": "localIpDetails" - } - }, - "RemoteIpDetails": { - "target": "com.amazonaws.guardduty#RemoteIpDetails", - "traits": { - "smithy.api#documentation": "The remote IP information of the connection.
", - "smithy.api#jsonName": "remoteIpDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the port probe details.
" - } - }, - "com.amazonaws.guardduty#PortProbeDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#PortProbeDetail" - } - }, - "com.amazonaws.guardduty#PositiveLong": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.guardduty#PrivateIpAddressDetails": { - "type": "structure", - "members": { - "PrivateDnsName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The private DNS name of the EC2 instance.
", - "smithy.api#jsonName": "privateDnsName" - } - }, - "PrivateIpAddress": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The private IP address of the EC2 instance.
", - "smithy.api#jsonName": "privateIpAddress" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains other private IP address information of the EC2 instance.
" - } - }, - "com.amazonaws.guardduty#PrivateIpAddresses": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#PrivateIpAddressDetails" - } - }, - "com.amazonaws.guardduty#ProcessDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the process.
", - "smithy.api#jsonName": "name" - } - }, - "ExecutablePath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The absolute path of the process executable file.
", - "smithy.api#jsonName": "executablePath" - } - }, - "ExecutableSha256": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The SHA256 hash of the process executable.
The ID of the child process.
", - "smithy.api#jsonName": "namespacePid" - } - }, - "Pwd": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The present working directory of the process.
", - "smithy.api#jsonName": "pwd" - } - }, - "Pid": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The ID of the process.
", - "smithy.api#jsonName": "pid" - } - }, - "StartTime": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the process started. This is in UTC format.
", - "smithy.api#jsonName": "startTime" - } - }, - "Uuid": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID assigned to the process by GuardDuty.
", - "smithy.api#jsonName": "uuid" - } - }, - "ParentUuid": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID of the parent process. This ID is assigned to the parent process by\n GuardDuty.
", - "smithy.api#jsonName": "parentUuid" - } - }, - "User": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The user that executed the process.
", - "smithy.api#jsonName": "user" - } - }, - "UserId": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The unique ID of the user that executed the process.
", - "smithy.api#jsonName": "userId" - } - }, - "Euid": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The effective user ID of the user that executed the process.
", - "smithy.api#jsonName": "euid" - } - }, - "Lineage": { - "target": "com.amazonaws.guardduty#Lineage", - "traits": { - "smithy.api#documentation": "Information about the process's lineage.
", - "smithy.api#jsonName": "lineage" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the observed process.
" - } - }, - "com.amazonaws.guardduty#ProductCode": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The product code information.
", - "smithy.api#jsonName": "productCodeId" - } - }, - "ProductType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The product code type.
", - "smithy.api#jsonName": "productCodeType" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the product code for the EC2 instance.
" - } - }, - "com.amazonaws.guardduty#ProductCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#ProductCode" - } - }, - "com.amazonaws.guardduty#ProfileSubtype": { - "type": "enum", - "members": { - "FREQUENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FREQUENT" - } - }, - "INFREQUENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFREQUENT" - } - }, - "UNSEEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNSEEN" - } - }, - "RARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RARE" - } - } - } - }, - "com.amazonaws.guardduty#ProfileType": { - "type": "enum", - "members": { - "FREQUENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FREQUENCY" - } - } - } - }, - "com.amazonaws.guardduty#PublicAccess": { - "type": "structure", - "members": { - "PermissionConfiguration": { - "target": "com.amazonaws.guardduty#PermissionConfiguration", - "traits": { - "smithy.api#documentation": "Contains information about how permissions are configured for the S3 bucket.
", - "smithy.api#jsonName": "permissionConfiguration" - } - }, - "EffectivePermission": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Describes the effective permission on this bucket after factoring all attached\n policies.
", - "smithy.api#jsonName": "effectivePermission" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
" - } - }, - "com.amazonaws.guardduty#PublishingStatus": { - "type": "enum", - "members": { - "PENDING_VERIFICATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING_VERIFICATION" - } - }, - "PUBLISHING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLISHING" - } - }, - "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#RdsDbInstanceDetails": { - "type": "structure", - "members": { - "DbInstanceIdentifier": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The identifier associated to the database instance that was involved in the\n finding.
", - "smithy.api#jsonName": "dbInstanceIdentifier" - } - }, - "Engine": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The database engine of the database instance involved in the finding.
", - "smithy.api#jsonName": "engine" - } - }, - "EngineVersion": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The version of the database engine that was involved in the finding.
", - "smithy.api#jsonName": "engineVersion" - } - }, - "DbClusterIdentifier": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The identifier of the database cluster that contains the database instance ID involved in\n the finding.
", - "smithy.api#jsonName": "dbClusterIdentifier" - } - }, - "DbInstanceArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the database instance involved in the\n finding.
", - "smithy.api#jsonName": "dbInstanceArn" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "Instance tag key-value pairs associated with the database instance ID.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the resource type RDSDBInstance involved in a\n GuardDuty finding.
The user name used in the anomalous login attempt.
", - "smithy.api#jsonName": "user" - } - }, - "Application": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The application name used in the anomalous login attempt.
", - "smithy.api#jsonName": "application" - } - }, - "Database": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the database instance involved in the anomalous login attempt.
", - "smithy.api#jsonName": "database" - } - }, - "Ssl": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The version of the Secure Socket Layer (SSL) used for the network.
", - "smithy.api#jsonName": "ssl" - } - }, - "AuthMethod": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The authentication method used by the user involved in the finding.
", - "smithy.api#jsonName": "authMethod" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the user and authentication details for a database instance\n involved in the finding.
" - } - }, - "com.amazonaws.guardduty#RdsLoginAttemptAction": { - "type": "structure", - "members": { - "RemoteIpDetails": { - "target": "com.amazonaws.guardduty#RemoteIpDetails", - "traits": { - "smithy.api#jsonName": "remoteIpDetails" - } - }, - "LoginAttributes": { - "target": "com.amazonaws.guardduty#LoginAttributes", - "traits": { - "smithy.api#documentation": "Indicates the login attributes used in the login attempt.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Indicates that a login attempt was made to the potentially compromised database from a\n remote IP address.
" - } - }, - "com.amazonaws.guardduty#RemoteAccountDetails": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the remote API caller.
", - "smithy.api#jsonName": "accountId" - } - }, - "Affiliated": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Details on whether the Amazon Web Services account of the remote API caller is related to your GuardDuty\n environment. If this value is True the API caller is affiliated to your account\n in some way. If it is False the API caller is from outside your\n environment.
Contains details about the remote Amazon Web Services account that made the API call.
" - } - }, - "com.amazonaws.guardduty#RemoteIpDetails": { - "type": "structure", - "members": { - "City": { - "target": "com.amazonaws.guardduty#City", - "traits": { - "smithy.api#documentation": "The city information of the remote IP address.
", - "smithy.api#jsonName": "city" - } - }, - "Country": { - "target": "com.amazonaws.guardduty#Country", - "traits": { - "smithy.api#documentation": "The country code of the remote IP address.
", - "smithy.api#jsonName": "country" - } - }, - "GeoLocation": { - "target": "com.amazonaws.guardduty#GeoLocation", - "traits": { - "smithy.api#documentation": "The location information of the remote IP address.
", - "smithy.api#jsonName": "geoLocation" - } - }, - "IpAddressV4": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The IPv4 remote address of the connection.
", - "smithy.api#jsonName": "ipAddressV4" - } - }, - "Organization": { - "target": "com.amazonaws.guardduty#Organization", - "traits": { - "smithy.api#documentation": "The ISP organization information of the remote IP address.
", - "smithy.api#jsonName": "organization" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the remote IP address of the connection.
" - } - }, - "com.amazonaws.guardduty#RemotePortDetails": { - "type": "structure", - "members": { - "Port": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The port number of the remote connection.
", - "smithy.api#jsonName": "port" - } - }, - "PortName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The port name of the remote connection.
", - "smithy.api#jsonName": "portName" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the remote port.
" - } - }, - "com.amazonaws.guardduty#Resource": { - "type": "structure", - "members": { - "AccessKeyDetails": { - "target": "com.amazonaws.guardduty#AccessKeyDetails", - "traits": { - "smithy.api#documentation": "The IAM access key details (user information) of a user that engaged in the activity that\n prompted GuardDuty to generate a finding.
", - "smithy.api#jsonName": "accessKeyDetails" - } - }, - "S3BucketDetails": { - "target": "com.amazonaws.guardduty#S3BucketDetails", - "traits": { - "smithy.api#documentation": "Contains information on the S3 bucket.
", - "smithy.api#jsonName": "s3BucketDetails" - } - }, - "InstanceDetails": { - "target": "com.amazonaws.guardduty#InstanceDetails", - "traits": { - "smithy.api#documentation": "The information about the EC2 instance associated with the activity that prompted\n GuardDuty to generate a finding.
", - "smithy.api#jsonName": "instanceDetails" - } - }, - "EksClusterDetails": { - "target": "com.amazonaws.guardduty#EksClusterDetails", - "traits": { - "smithy.api#documentation": "Details about the EKS cluster involved in a Kubernetes finding.
", - "smithy.api#jsonName": "eksClusterDetails" - } - }, - "KubernetesDetails": { - "target": "com.amazonaws.guardduty#KubernetesDetails", - "traits": { - "smithy.api#documentation": "Details about the Kubernetes user and workload involved in a Kubernetes finding.
", - "smithy.api#jsonName": "kubernetesDetails" - } - }, - "ResourceType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The type of Amazon Web Services resource.
", - "smithy.api#jsonName": "resourceType" - } - }, - "EbsVolumeDetails": { - "target": "com.amazonaws.guardduty#EbsVolumeDetails", - "traits": { - "smithy.api#documentation": "Contains list of scanned and skipped EBS volumes with details.
", - "smithy.api#jsonName": "ebsVolumeDetails" - } - }, - "EcsClusterDetails": { - "target": "com.amazonaws.guardduty#EcsClusterDetails", - "traits": { - "smithy.api#documentation": "Contains information about the details of the ECS Cluster.
", - "smithy.api#jsonName": "ecsClusterDetails" - } - }, - "ContainerDetails": { - "target": "com.amazonaws.guardduty#Container", - "traits": { - "smithy.api#jsonName": "containerDetails" - } - }, - "RdsDbInstanceDetails": { - "target": "com.amazonaws.guardduty#RdsDbInstanceDetails", - "traits": { - "smithy.api#documentation": "Contains information about the database instance to which an anomalous login attempt was\n made.
", - "smithy.api#jsonName": "rdsDbInstanceDetails" - } - }, - "RdsDbUserDetails": { - "target": "com.amazonaws.guardduty#RdsDbUserDetails", - "traits": { - "smithy.api#documentation": "Contains information about the user details through which anomalous login attempt was\n made.
", - "smithy.api#jsonName": "rdsDbUserDetails" - } - }, - "LambdaDetails": { - "target": "com.amazonaws.guardduty#LambdaDetails", - "traits": { - "smithy.api#documentation": "Contains information about the Lambda function that was involved in a finding.
", - "smithy.api#jsonName": "lambdaDetails" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the Amazon Web Services resource associated with the activity that prompted\n GuardDuty to generate a finding.
" - } - }, - "com.amazonaws.guardduty#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[A-Za-z-]+:[A-Za-z0-9]+:[A-Za-z0-9-]+:\\d+:(([A-Za-z0-9-]+)[:\\/])?[A-Za-z0-9-]*$" - } - }, - "com.amazonaws.guardduty#ResourceDetails": { - "type": "structure", - "members": { - "InstanceArn": { - "target": "com.amazonaws.guardduty#InstanceArn", - "traits": { - "smithy.api#documentation": "InstanceArn that was scanned in the scan entry.
", - "smithy.api#jsonName": "instanceArn" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
" - } - }, - "com.amazonaws.guardduty#ResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#ResourceType": { - "type": "enum", - "members": { - "EKS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS" - } - }, - "ECS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ECS" - } - }, - "EC2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2" - } - } - } - }, - "com.amazonaws.guardduty#RuntimeContext": { - "type": "structure", - "members": { - "ModifyingProcess": { - "target": "com.amazonaws.guardduty#ProcessDetails", - "traits": { - "smithy.api#documentation": "Information about the process that modified the current process. This is available for\n multiple finding types.
", - "smithy.api#jsonName": "modifyingProcess" - } - }, - "ModifiedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp at which the process modified the current process. The timestamp is in UTC date string\n format.
", - "smithy.api#jsonName": "modifiedAt" - } - }, - "ScriptPath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The path to the script that was executed.
", - "smithy.api#jsonName": "scriptPath" - } - }, - "LibraryPath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The path to the new library that was loaded.
", - "smithy.api#jsonName": "libraryPath" - } - }, - "LdPreloadValue": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The value of the LD_PRELOAD environment variable.
", - "smithy.api#jsonName": "ldPreloadValue" - } - }, - "SocketPath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The path to the docket socket that was accessed.
", - "smithy.api#jsonName": "socketPath" - } - }, - "RuncBinaryPath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The path to the leveraged runc implementation.
The path in the container that modified the release agent file.
", - "smithy.api#jsonName": "releaseAgentPath" - } - }, - "MountSource": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The path on the host that is mounted by the container.
", - "smithy.api#jsonName": "mountSource" - } - }, - "MountTarget": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The path in the container that is mapped to the host directory.
", - "smithy.api#jsonName": "mountTarget" - } - }, - "FileSystemType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Represents the type of mounted fileSystem.
", - "smithy.api#jsonName": "fileSystemType" - } - }, - "Flags": { - "target": "com.amazonaws.guardduty#FlagsList", - "traits": { - "smithy.api#documentation": "Represents options that control the behavior of a runtime operation or action. For\n example, a filesystem mount operation may contain a read-only flag.
", - "smithy.api#jsonName": "flags" - } - }, - "ModuleName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the module loaded into the kernel.
", - "smithy.api#jsonName": "moduleName" - } - }, - "ModuleFilePath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The path to the module loaded into the kernel.
", - "smithy.api#jsonName": "moduleFilePath" - } - }, - "ModuleSha256": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The SHA256 hash of the module.
The path to the modified shell history file.
", - "smithy.api#jsonName": "shellHistoryFilePath" - } - }, - "TargetProcess": { - "target": "com.amazonaws.guardduty#ProcessDetails", - "traits": { - "smithy.api#documentation": "Information about the process that had its memory overwritten by the current process.
", - "smithy.api#jsonName": "targetProcess" - } - }, - "AddressFamily": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Represents the communication protocol associated with the address. For example, the address\n family AF_INET is used for IP version of 4 protocol.
Specifies a particular protocol within the address family. Usually there is a single\n protocol in address families. For example, the address family AF_INET only has\n the IP protocol.
Specifies the Region of a process's address space such as stack and heap.
", - "smithy.api#jsonName": "memoryRegions" - } - } - }, - "traits": { - "smithy.api#documentation": "Additional information about the suspicious activity.
" - } - }, - "com.amazonaws.guardduty#RuntimeDetails": { - "type": "structure", - "members": { - "Process": { - "target": "com.amazonaws.guardduty#ProcessDetails", - "traits": { - "smithy.api#documentation": "Information about the observed process.
", - "smithy.api#jsonName": "process" - } - }, - "Context": { - "target": "com.amazonaws.guardduty#RuntimeContext", - "traits": { - "smithy.api#documentation": "Additional information about the suspicious activity.
", - "smithy.api#jsonName": "context" - } - } - }, - "traits": { - "smithy.api#documentation": "Information about the process and any required context values for a specific\n finding.
" - } - }, - "com.amazonaws.guardduty#S3BucketDetail": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the S3 bucket.
", - "smithy.api#jsonName": "arn" - } - }, - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the S3 bucket.
", - "smithy.api#jsonName": "name" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Describes whether the bucket is a source or destination bucket.
", - "smithy.api#jsonName": "type" - } - }, - "CreatedAt": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time the bucket was created at.
", - "smithy.api#jsonName": "createdAt" - } - }, - "Owner": { - "target": "com.amazonaws.guardduty#Owner", - "traits": { - "smithy.api#documentation": "The owner of the S3 bucket.
", - "smithy.api#jsonName": "owner" - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#Tags", - "traits": { - "smithy.api#documentation": "All tags attached to the S3 bucket
", - "smithy.api#jsonName": "tags" - } - }, - "DefaultServerSideEncryption": { - "target": "com.amazonaws.guardduty#DefaultServerSideEncryption", - "traits": { - "smithy.api#documentation": "Describes the server side encryption method used in the S3 bucket.
", - "smithy.api#jsonName": "defaultServerSideEncryption" - } - }, - "PublicAccess": { - "target": "com.amazonaws.guardduty#PublicAccess", - "traits": { - "smithy.api#documentation": "Describes the public access policies that apply to the S3 bucket.
", - "smithy.api#jsonName": "publicAccess" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the S3 bucket.
" - } - }, - "com.amazonaws.guardduty#S3BucketDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#S3BucketDetail" - } - }, - "com.amazonaws.guardduty#S3LogsConfiguration": { - "type": "structure", - "members": { - "Enable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The status of S3 data event logs as a data source.
", - "smithy.api#jsonName": "enable", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#S3LogsConfigurationResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.guardduty#DataSourceStatus", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A value that describes whether S3 data event logs are automatically enabled for new\n members of the organization.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether S3 data event logs will be enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#Scan": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that the request is associated with.
", - "smithy.api#jsonName": "detectorId" - } - }, - "AdminDetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique detector ID of the administrator account that the request is associated with.\n Note that this value will be the same as the one used for DetectorId if the\n account is an administrator.
The unique scan ID associated with a scan entry.
", - "smithy.api#jsonName": "scanId" - } - }, - "ScanStatus": { - "target": "com.amazonaws.guardduty#ScanStatus", - "traits": { - "smithy.api#documentation": "An enum value representing possible scan statuses.
", - "smithy.api#jsonName": "scanStatus" - } - }, - "FailureReason": { - "target": "com.amazonaws.guardduty#NonEmptyString", - "traits": { - "smithy.api#documentation": "Represents the reason for FAILED scan status.
", - "smithy.api#jsonName": "failureReason" - } - }, - "ScanStartTime": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the scan was triggered.
", - "smithy.api#jsonName": "scanStartTime" - } - }, - "ScanEndTime": { - "target": "com.amazonaws.guardduty#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the scan was finished.
", - "smithy.api#jsonName": "scanEndTime" - } - }, - "TriggerDetails": { - "target": "com.amazonaws.guardduty#TriggerDetails", - "traits": { - "smithy.api#documentation": "Specifies the reason why the scan was initiated.
", - "smithy.api#jsonName": "triggerDetails" - } - }, - "ResourceDetails": { - "target": "com.amazonaws.guardduty#ResourceDetails", - "traits": { - "smithy.api#documentation": "Represents the resources that were scanned in the scan entry.
", - "smithy.api#jsonName": "resourceDetails" - } - }, - "ScanResultDetails": { - "target": "com.amazonaws.guardduty#ScanResultDetails", - "traits": { - "smithy.api#documentation": "Represents the result of the scan.
", - "smithy.api#jsonName": "scanResultDetails" - } - }, - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "The ID for the account that belongs to the scan.
", - "smithy.api#jsonName": "accountId" - } - }, - "TotalBytes": { - "target": "com.amazonaws.guardduty#PositiveLong", - "traits": { - "smithy.api#documentation": "Represents total bytes that were scanned.
", - "smithy.api#jsonName": "totalBytes" - } - }, - "FileCount": { - "target": "com.amazonaws.guardduty#PositiveLong", - "traits": { - "smithy.api#documentation": "Represents the number of files that were scanned.
", - "smithy.api#jsonName": "fileCount" - } - }, - "AttachedVolumes": { - "target": "com.amazonaws.guardduty#VolumeDetails", - "traits": { - "smithy.api#documentation": "List of volumes that were attached to the original instance to be scanned.
", - "smithy.api#jsonName": "attachedVolumes" - } - }, - "ScanType": { - "target": "com.amazonaws.guardduty#ScanType", - "traits": { - "smithy.api#documentation": "Specifies the scan type that invoked the malware scan.
", - "smithy.api#jsonName": "scanType" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a malware scan.
" - } - }, - "com.amazonaws.guardduty#ScanCondition": { - "type": "structure", - "members": { - "MapEquals": { - "target": "com.amazonaws.guardduty#MapEquals", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Represents an mapEqual\n condition to be applied\n to a single field when triggering for malware scan.
", - "smithy.api#jsonName": "mapEquals", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the condition.
" - } - }, - "com.amazonaws.guardduty#ScanConditionPair": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.guardduty#TagKey", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Represents the key in the map condition.
", - "smithy.api#jsonName": "key", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.guardduty#TagValue", - "traits": { - "smithy.api#documentation": "Represents optional value in the map\n condition. If not specified, only the key will be\n matched.
", - "smithy.api#jsonName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the key:value pair to be matched against given resource property.
Represents a map of resource properties that match specified conditions and values when\n triggering malware scans.
" - } - }, - "com.amazonaws.guardduty#ScanCriterionKey": { - "type": "enum", - "members": { - "EC2_INSTANCE_TAG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2_INSTANCE_TAG" - } - } - }, - "traits": { - "smithy.api#documentation": "An enum value representing possible resource properties to match with given scan\n condition.
" - } - }, - "com.amazonaws.guardduty#ScanDetections": { - "type": "structure", - "members": { - "ScannedItemCount": { - "target": "com.amazonaws.guardduty#ScannedItemCount", - "traits": { - "smithy.api#documentation": "Total number of scanned files.
", - "smithy.api#jsonName": "scannedItemCount" - } - }, - "ThreatsDetectedItemCount": { - "target": "com.amazonaws.guardduty#ThreatsDetectedItemCount", - "traits": { - "smithy.api#documentation": "Total number of infected files.
", - "smithy.api#jsonName": "threatsDetectedItemCount" - } - }, - "HighestSeverityThreatDetails": { - "target": "com.amazonaws.guardduty#HighestSeverityThreatDetails", - "traits": { - "smithy.api#documentation": "Details of the highest severity threat detected during malware scan and number of infected\n files.
", - "smithy.api#jsonName": "highestSeverityThreatDetails" - } - }, - "ThreatDetectedByName": { - "target": "com.amazonaws.guardduty#ThreatDetectedByName", - "traits": { - "smithy.api#documentation": "Contains details about identified threats organized by threat name.
", - "smithy.api#jsonName": "threatDetectedByName" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains a complete view providing malware scan result details.
" - } - }, - "com.amazonaws.guardduty#ScanEc2InstanceWithFindings": { - "type": "structure", - "members": { - "EbsVolumes": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Describes the configuration for scanning EBS volumes as data source.
", - "smithy.api#jsonName": "ebsVolumes" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes whether Malware Protection for EC2 instances with findings will be enabled as a\n data source.
" - } - }, - "com.amazonaws.guardduty#ScanEc2InstanceWithFindingsResult": { - "type": "structure", - "members": { - "EbsVolumes": { - "target": "com.amazonaws.guardduty#EbsVolumesResult", - "traits": { - "smithy.api#documentation": "Describes the configuration of scanning EBS volumes as a data source.
", - "smithy.api#jsonName": "ebsVolumes" - } - } - }, - "traits": { - "smithy.api#documentation": "An object that contains information on the status of whether Malware Protection for EC2\n instances with findings will be enabled as a data source.
" - } - }, - "com.amazonaws.guardduty#ScanFilePath": { - "type": "structure", - "members": { - "FilePath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The file path of the infected file.
", - "smithy.api#jsonName": "filePath" - } - }, - "VolumeArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "EBS volume Arn details of the infected file.
", - "smithy.api#jsonName": "volumeArn" - } - }, - "Hash": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The hash value of the infected file.
", - "smithy.api#jsonName": "hash" - } - }, - "FileName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "File name of the infected file.
", - "smithy.api#jsonName": "fileName" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details of infected file including name, file path and hash.
" - } - }, - "com.amazonaws.guardduty#ScanResourceCriteria": { - "type": "structure", - "members": { - "Include": { - "target": "com.amazonaws.guardduty#ScanCriterion", - "traits": { - "smithy.api#documentation": "Represents condition that when matched will allow a malware scan for a certain\n resource.
", - "smithy.api#jsonName": "include" - } - }, - "Exclude": { - "target": "com.amazonaws.guardduty#ScanCriterion", - "traits": { - "smithy.api#documentation": "Represents condition that when matched will prevent a malware scan for a certain\n resource.
", - "smithy.api#jsonName": "exclude" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about criteria used to filter resources before triggering malware\n scan.
" - } - }, - "com.amazonaws.guardduty#ScanResult": { - "type": "enum", - "members": { - "CLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLEAN" - } - }, - "INFECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFECTED" - } - } - } - }, - "com.amazonaws.guardduty#ScanResultDetails": { - "type": "structure", - "members": { - "ScanResult": { - "target": "com.amazonaws.guardduty#ScanResult", - "traits": { - "smithy.api#documentation": "An enum value representing possible scan results.
", - "smithy.api#jsonName": "scanResult" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the result of the scan.
" - } - }, - "com.amazonaws.guardduty#ScanStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - } - } - }, - "com.amazonaws.guardduty#ScanThreatName": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the identified threat.
", - "smithy.api#jsonName": "name" - } - }, - "Severity": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Severity of threat identified as part of the malware scan.
", - "smithy.api#jsonName": "severity" - } - }, - "ItemCount": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Total number of files infected with given threat.
", - "smithy.api#jsonName": "itemCount" - } - }, - "FilePaths": { - "target": "com.amazonaws.guardduty#FilePaths", - "traits": { - "smithy.api#documentation": "List of infected files in EBS volume with details.
", - "smithy.api#jsonName": "filePaths" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains files infected with the given threat providing details of malware name and\n severity.
" - } - }, - "com.amazonaws.guardduty#ScanThreatNames": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#ScanThreatName" - } - }, - "com.amazonaws.guardduty#ScanType": { - "type": "enum", - "members": { - "GUARDDUTY_INITIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GUARDDUTY_INITIATED" - } - }, - "ON_DEMAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ON_DEMAND" - } - } - } - }, - "com.amazonaws.guardduty#ScannedItemCount": { - "type": "structure", - "members": { - "TotalGb": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Total GB of files scanned for malware.
", - "smithy.api#jsonName": "totalGb" - } - }, - "Files": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Number of files scanned.
", - "smithy.api#jsonName": "files" - } - }, - "Volumes": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Total number of scanned volumes.
", - "smithy.api#jsonName": "volumes" - } - } - }, - "traits": { - "smithy.api#documentation": "Total number of scanned files.
" - } - }, - "com.amazonaws.guardduty#Scans": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Scan" - } - }, - "com.amazonaws.guardduty#SecurityContext": { - "type": "structure", - "members": { - "Privileged": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Whether the container is privileged.
", - "smithy.api#jsonName": "privileged" - } - }, - "AllowPrivilegeEscalation": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process.
", - "smithy.api#jsonName": "allowPrivilegeEscalation" - } - } - }, - "traits": { - "smithy.api#documentation": "Container security context.
" - } - }, - "com.amazonaws.guardduty#SecurityGroup": { - "type": "structure", - "members": { - "GroupId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The security group ID of the EC2 instance.
", - "smithy.api#jsonName": "groupId" - } - }, - "GroupName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The security group name of the EC2 instance.
", - "smithy.api#jsonName": "groupName" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the security groups associated with the EC2 instance.
" - } - }, - "com.amazonaws.guardduty#SecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#SecurityGroup" - } - }, - "com.amazonaws.guardduty#Service": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.guardduty#Action", - "traits": { - "smithy.api#documentation": "Information about the activity that is described in a finding.
", - "smithy.api#jsonName": "action" - } - }, - "Evidence": { - "target": "com.amazonaws.guardduty#Evidence", - "traits": { - "smithy.api#documentation": "An evidence object associated with the service.
", - "smithy.api#jsonName": "evidence" - } - }, - "Archived": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Indicates whether this finding is archived.
", - "smithy.api#jsonName": "archived" - } - }, - "Count": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "The total count of the occurrences of this finding type.
", - "smithy.api#jsonName": "count" - } - }, - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The detector ID for the GuardDuty service.
", - "smithy.api#jsonName": "detectorId" - } - }, - "EventFirstSeen": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The first-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.
", - "smithy.api#jsonName": "eventFirstSeen" - } - }, - "EventLastSeen": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The last-seen timestamp of the activity that prompted GuardDuty to generate this\n finding.
", - "smithy.api#jsonName": "eventLastSeen" - } - }, - "ResourceRole": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The resource role information for this finding.
", - "smithy.api#jsonName": "resourceRole" - } - }, - "ServiceName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the Amazon Web Services service (GuardDuty) that generated a finding.
", - "smithy.api#jsonName": "serviceName" - } - }, - "UserFeedback": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Feedback that was submitted about the finding.
", - "smithy.api#jsonName": "userFeedback" - } - }, - "AdditionalInfo": { - "target": "com.amazonaws.guardduty#ServiceAdditionalInfo", - "traits": { - "smithy.api#documentation": "Contains additional information about the generated finding.
", - "smithy.api#jsonName": "additionalInfo" - } - }, - "FeatureName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the feature that generated a finding.
", - "smithy.api#jsonName": "featureName" - } - }, - "EbsVolumeScanDetails": { - "target": "com.amazonaws.guardduty#EbsVolumeScanDetails", - "traits": { - "smithy.api#documentation": "Returns details from the malware scan that created a finding.
", - "smithy.api#jsonName": "ebsVolumeScanDetails" - } - }, - "RuntimeDetails": { - "target": "com.amazonaws.guardduty#RuntimeDetails", - "traits": { - "smithy.api#documentation": "Information about the process and any required context values for a specific\n finding
", - "smithy.api#jsonName": "runtimeDetails" - } - }, - "Detection": { - "target": "com.amazonaws.guardduty#Detection", - "traits": { - "smithy.api#documentation": "Contains information about the detected unusual behavior.
", - "smithy.api#jsonName": "detection" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains additional information about the generated finding.
" - } - }, - "com.amazonaws.guardduty#ServiceAdditionalInfo": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "This field specifies the value of the additional information.
", - "smithy.api#jsonName": "value" - } - }, - "Type": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Describes the type of the additional information.
", - "smithy.api#jsonName": "type" - } - } - }, - "traits": { - "smithy.api#documentation": "Additional information about the generated finding.
" - } - }, - "com.amazonaws.guardduty#SessionNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#SortCriteria": { - "type": "structure", - "members": { - "AttributeName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Represents the finding attribute, such as accountId, that sorts the\n findings.
The order by which the sorted findings are to be displayed.
", - "smithy.api#jsonName": "orderBy" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the criteria used for sorting findings.
" - } - }, - "com.amazonaws.guardduty#SourceIps": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Sources": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#StartMalwareScan": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#StartMalwareScanRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#StartMalwareScanResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#ConflictException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Initiates the malware scan. Invoking this API will automatically create the Service-linked role in \n the corresponding account.
", - "smithy.api#http": { - "method": "POST", - "uri": "/malware-scan/start", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#StartMalwareScanRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.guardduty#ResourceArn", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Amazon Resource Name (ARN) of the resource for which you invoked the API.
", - "smithy.api#jsonName": "resourceArn", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#StartMalwareScanResponse": { - "type": "structure", - "members": { - "ScanId": { - "target": "com.amazonaws.guardduty#NonEmptyString", - "traits": { - "smithy.api#documentation": "A unique identifier that gets generated when you invoke the API without any error. Each malware scan has \n a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
", - "smithy.api#jsonName": "scanId" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#StartMonitoringMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#StartMonitoringMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#StartMonitoringMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Turns on GuardDuty monitoring of the specified member accounts. Use this operation to\n restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/member/start", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#StartMonitoringMembersRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector of the GuardDuty administrator account associated with the\n member accounts to monitor.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs of the GuardDuty member accounts to start monitoring.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#StartMonitoringMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that contain the unprocessed account and a result string that explains\n why it was unprocessed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#StopMonitoringMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#StopMonitoringMembersRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#StopMonitoringMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Stops GuardDuty monitoring for the specified member accounts. Use the\n StartMonitoringMembers operation to restart monitoring for those\n accounts.
With autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to stop monitoring the member\n accounts in your organization.
The unique ID of the detector associated with the GuardDuty administrator account that is\n monitoring member accounts.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of account IDs for the member accounts to stop monitoring.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#StopMonitoringMembersResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of objects that contain an accountId for each account that could not be processed,\n and a result string that indicates why the account was not processed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#String": { - "type": "string" - }, - "com.amazonaws.guardduty#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The EC2 instance tag key.
", - "smithy.api#jsonName": "key" - } - }, - "Value": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The EC2 instance tag value.
", - "smithy.api#jsonName": "value" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about a tag associated with the EC2 instance.
" - } - }, - "com.amazonaws.guardduty#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.guardduty#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.guardduty#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.guardduty#TagKey" - }, - "value": { - "target": "com.amazonaws.guardduty#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.guardduty#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#AccessDeniedException" - }, - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Adds tags to a resource.
", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 204 - } - } - }, - "com.amazonaws.guardduty#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.guardduty#GuardDutyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "resourceArn", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.guardduty#TagMap", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The tags to be added to a resource.
", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.guardduty#Tags": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Tag" - } - }, - "com.amazonaws.guardduty#ThreatDetectedByName": { - "type": "structure", - "members": { - "ItemCount": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Total number of infected files identified.
", - "smithy.api#jsonName": "itemCount" - } - }, - "UniqueThreatNameCount": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Total number of unique threats by name identified, as part of the malware scan.
", - "smithy.api#jsonName": "uniqueThreatNameCount" - } - }, - "Shortened": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Flag to determine if the finding contains every single infected file-path and/or every\n threat.
", - "smithy.api#jsonName": "shortened" - } - }, - "ThreatNames": { - "target": "com.amazonaws.guardduty#ScanThreatNames", - "traits": { - "smithy.api#documentation": "List of identified threats with details, organized by threat name.
", - "smithy.api#jsonName": "threatNames" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains details about identified threats organized by threat name.
" - } - }, - "com.amazonaws.guardduty#ThreatIntelSetFormat": { - "type": "enum", - "members": { - "TXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TXT" - } - }, - "STIX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STIX" - } - }, - "OTX_CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTX_CSV" - } - }, - "ALIEN_VAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALIEN_VAULT" - } - }, - "PROOF_POINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROOF_POINT" - } - }, - "FIRE_EYE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIRE_EYE" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#ThreatIntelSetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#ThreatIntelSetStatus": { - "type": "enum", - "members": { - "INACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INACTIVE" - } - }, - "ACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DEACTIVATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEACTIVATING" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "DELETE_PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_PENDING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.guardduty#ThreatIntelligenceDetail": { - "type": "structure", - "members": { - "ThreatListName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the threat intelligence list that triggered the finding.
", - "smithy.api#jsonName": "threatListName" - } - }, - "ThreatNames": { - "target": "com.amazonaws.guardduty#ThreatNames", - "traits": { - "smithy.api#documentation": "A list of names of the threats in the threat intelligence list that triggered the\n finding.
", - "smithy.api#jsonName": "threatNames" - } - } - }, - "traits": { - "smithy.api#documentation": "An instance of a threat intelligence detail that constitutes evidence for the\n finding.
" - } - }, - "com.amazonaws.guardduty#ThreatIntelligenceDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#ThreatIntelligenceDetail" - } - }, - "com.amazonaws.guardduty#ThreatNames": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#String" - } - }, - "com.amazonaws.guardduty#ThreatsDetectedItemCount": { - "type": "structure", - "members": { - "Files": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "Total number of infected files.
", - "smithy.api#jsonName": "files" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains total number of infected files.
" - } - }, - "com.amazonaws.guardduty#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.guardduty#Total": { - "type": "structure", - "members": { - "Amount": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The total usage.
", - "smithy.api#jsonName": "amount" - } - }, - "Unit": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The currency unit that the amount is given in.
", - "smithy.api#jsonName": "unit" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the total usage with the corresponding currency unit for that value.
" - } - }, - "com.amazonaws.guardduty#TriggerDetails": { - "type": "structure", - "members": { - "GuardDutyFindingId": { - "target": "com.amazonaws.guardduty#NonEmptyString", - "traits": { - "smithy.api#documentation": "The ID of the GuardDuty finding that triggered the malware scan.
", - "smithy.api#jsonName": "guardDutyFindingId" - } - }, - "Description": { - "target": "com.amazonaws.guardduty#NonEmptyString", - "traits": { - "smithy.api#documentation": "The description of the scan trigger.
", - "smithy.api#jsonName": "description" - } - } - }, - "traits": { - "smithy.api#documentation": "Represents the reason the scan was triggered.
" - } - }, - "com.amazonaws.guardduty#UnarchiveFindings": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UnarchiveFindingsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UnarchiveFindingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Unarchives GuardDuty findings specified by the findingIds.
The ID of the detector associated with the findings to unarchive.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FindingIds": { - "target": "com.amazonaws.guardduty#FindingIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the findings to unarchive.
", - "smithy.api#jsonName": "findingIds", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UnarchiveFindingsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UnprocessedAccount": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Web Services account ID.
", - "smithy.api#jsonName": "accountId", - "smithy.api#required": {} - } - }, - "Result": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A reason why the account hasn't been processed.
", - "smithy.api#jsonName": "result", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the accounts that weren't processed.
" - } - }, - "com.amazonaws.guardduty#UnprocessedAccounts": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#UnprocessedAccount" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.guardduty#UnprocessedDataSourcesResult": { - "type": "structure", - "members": { - "MalwareProtection": { - "target": "com.amazonaws.guardduty#MalwareProtectionConfigurationResult", - "traits": { - "smithy.api#jsonName": "malwareProtection" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the names of the data sources that couldn't be enabled.
" - } - }, - "com.amazonaws.guardduty#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#AccessDeniedException" - }, - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Removes tags from a resource.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 204 - } - } - }, - "com.amazonaws.guardduty#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.guardduty#GuardDutyArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource to remove tags from.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "resourceArn", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.guardduty#TagKeyList", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The tag keys to remove from the resource.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#jsonName": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UpdateDetector": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UpdateDetectorRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UpdateDetectorResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the Amazon GuardDuty detector specified by the detectorId.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateDetectorRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "Enable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "Specifies whether the detector is enabled or not enabled.
", - "smithy.api#jsonName": "enable" - } - }, - "FindingPublishingFrequency": { - "target": "com.amazonaws.guardduty#FindingPublishingFrequency", - "traits": { - "smithy.api#documentation": "An enum value that specifies how frequently findings are exported, such as to CloudWatch\n Events.
", - "smithy.api#jsonName": "findingPublishingFrequency" - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurations", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "Describes which data sources will be updated.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#DetectorFeatureConfigurations", - "traits": { - "smithy.api#documentation": "Provides the features that will be updated for the detector.
", - "smithy.api#jsonName": "features" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UpdateDetectorResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UpdateFilter": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UpdateFilterRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UpdateFilterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the filter specified by the filter name.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/filter/{FilterName}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateFilterRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to\n update a filter.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FilterName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The name of the filter.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "filterName", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.guardduty#FilterDescription", - "traits": { - "smithy.api#documentation": "The description of the filter. Valid characters include alphanumeric characters, and\n special characters such as hyphen, period, colon, underscore, parentheses ({ },\n [ ], and ( )), forward slash, horizontal tab, vertical tab,\n newline, form feed, return, and whitespace.
Specifies the action that is to be applied to the findings that match the filter.
", - "smithy.api#jsonName": "action" - } - }, - "Rank": { - "target": "com.amazonaws.guardduty#FilterRank", - "traits": { - "smithy.api#documentation": "Specifies the position of the filter in the list of current filters. Also specifies the\n order in which this filter is applied to the findings.
", - "smithy.api#jsonName": "rank" - } - }, - "FindingCriteria": { - "target": "com.amazonaws.guardduty#FindingCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria to be used in the filter for querying findings.
", - "smithy.api#jsonName": "findingCriteria" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UpdateFilterResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#FilterName", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the filter.
", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UpdateFindingsFeedback": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UpdateFindingsFeedbackRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UpdateFindingsFeedbackResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Marks the specified GuardDuty findings as useful or not useful.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/findings/feedback", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateFindingsFeedbackRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector associated with the findings to update feedback for.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "FindingIds": { - "target": "com.amazonaws.guardduty#FindingIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The IDs of the findings that you want to mark as useful or not useful.
", - "smithy.api#jsonName": "findingIds", - "smithy.api#required": {} - } - }, - "Feedback": { - "target": "com.amazonaws.guardduty#Feedback", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The feedback for the finding.
", - "smithy.api#jsonName": "feedback", - "smithy.api#required": {} - } - }, - "Comments": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Additional feedback about the GuardDuty findings.
", - "smithy.api#jsonName": "comments" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UpdateFindingsFeedbackResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UpdateIPSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UpdateIPSetRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UpdateIPSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the IPSet specified by the IPSet ID.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/ipset/{IpSetId}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateIPSetRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose IPSet you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "IpSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID that specifies the IPSet that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "ipSetId", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.guardduty#Name", - "traits": { - "smithy.api#documentation": "The unique ID that specifies the IPSet that you want to update.
", - "smithy.api#jsonName": "name" - } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#documentation": "The updated URI of the file that contains the IPSet.
", - "smithy.api#jsonName": "location" - } - }, - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "The updated Boolean value that specifies whether the IPSet is active or not.
", - "smithy.api#jsonName": "activate" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UpdateIPSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UpdateMalwareScanSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UpdateMalwareScanSettingsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UpdateMalwareScanSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the malware scan settings.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/malware-scan-settings", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateMalwareScanSettingsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The unique ID of the detector that specifies the GuardDuty service where you want to\n update scan settings.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "ScanResourceCriteria": { - "target": "com.amazonaws.guardduty#ScanResourceCriteria", - "traits": { - "smithy.api#documentation": "Represents the criteria to be used in the filter for selecting resources to scan.
", - "smithy.api#jsonName": "scanResourceCriteria" - } - }, - "EbsSnapshotPreservation": { - "target": "com.amazonaws.guardduty#EbsSnapshotPreservation", - "traits": { - "smithy.api#documentation": "An enum value representing possible snapshot preservation settings.
", - "smithy.api#jsonName": "ebsSnapshotPreservation" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UpdateMalwareScanSettingsResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UpdateMemberDetectors": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UpdateMemberDetectorsRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UpdateMemberDetectorsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Contains information on member accounts to be updated.
\nThere might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/member/detector/update", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateMemberDetectorsRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The detector ID of the administrator account.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of member account IDs to be updated.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceConfigurations", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "Describes which data sources will be updated.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#MemberFeaturesConfigurations", - "traits": { - "smithy.api#documentation": "A list of features that will be updated for the specified member accounts.
", - "smithy.api#jsonName": "features" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UpdateMemberDetectorsResponse": { - "type": "structure", - "members": { - "UnprocessedAccounts": { - "target": "com.amazonaws.guardduty#UnprocessedAccounts", - "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "A list of member account IDs that were unable to be processed along with an explanation\n for why they were not processed.
", - "smithy.api#jsonName": "unprocessedAccounts", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UpdateOrganizationConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.guardduty#UpdateOrganizationConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.guardduty#UpdateOrganizationConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.guardduty#BadRequestException" - }, - { - "target": "com.amazonaws.guardduty#InternalServerErrorException" - } - ], - "traits": { - "smithy.api#documentation": "Configures the delegated administrator account with the provided values. You must provide\n a value for either autoEnableOrganizationMembers or autoEnable, but not both.
There might be regional differences because some data sources might not be \n available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more \n information, see Regions and endpoints.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/admin", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateOrganizationConfigurationRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The ID of the detector that configures the delegated administrator.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "AutoEnable": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#deprecated": { - "message": "This field is deprecated, use AutoEnableOrganizationMembers instead" - }, - "smithy.api#documentation": "Represents whether or not to automatically enable member accounts in the organization.
\nEven though this is still supported, we recommend using\n AutoEnableOrganizationMembers to achieve the similar results. You must provide a \n value for either autoEnableOrganizationMembers or autoEnable.
Describes which data sources will be updated.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#OrganizationFeaturesConfigurations", - "traits": { - "smithy.api#documentation": "A list of features that will be configured for the organization.
", - "smithy.api#jsonName": "features" - } - }, - "AutoEnableOrganizationMembers": { - "target": "com.amazonaws.guardduty#AutoEnableMembers", - "traits": { - "smithy.api#documentation": "Indicates the auto-enablement configuration of GuardDuty for the member accounts in the\n organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.
Use one of the \n following configuration values for autoEnableOrganizationMembers:
\n NEW: Indicates that when a new account joins the organization, they will\n have GuardDuty enabled automatically.
\n ALL: Indicates that all accounts in the organization have GuardDuty\n enabled automatically. This includes NEW accounts that join the organization\n and accounts that may have been suspended or removed from the organization in\n GuardDuty.
It may take up to 24 hours to update the configuration for all the member accounts.
\n\n NONE: Indicates that GuardDuty will not be automatically enabled for any\n account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
Updates information about the publishing destination specified by the\n destinationId.
The ID of the detector associated with the publishing destinations to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "DestinationId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The ID of the publishing destination to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "destinationId", - "smithy.api#required": {} - } - }, - "DestinationProperties": { - "target": "com.amazonaws.guardduty#DestinationProperties", - "traits": { - "smithy.api#documentation": "A DestinationProperties object that includes the DestinationArn\n and KmsKeyArn of the publishing destination.
Updates the ThreatIntelSet specified by the ThreatIntelSet ID.
", - "smithy.api#http": { - "method": "POST", - "uri": "/detector/{DetectorId}/threatintelset/{ThreatIntelSetId}", - "code": 200 - } - } - }, - "com.amazonaws.guardduty#UpdateThreatIntelSetRequest": { - "type": "structure", - "members": { - "DetectorId": { - "target": "com.amazonaws.guardduty#DetectorId", - "traits": { - "smithy.api#documentation": "The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to\n update.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "detectorId", - "smithy.api#required": {} - } - }, - "ThreatIntelSetId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The unique ID that specifies the ThreatIntelSet that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#jsonName": "threatIntelSetId", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.guardduty#Name", - "traits": { - "smithy.api#documentation": "The unique ID that specifies the ThreatIntelSet that you want to update.
", - "smithy.api#jsonName": "name" - } - }, - "Location": { - "target": "com.amazonaws.guardduty#Location", - "traits": { - "smithy.api#documentation": "The updated URI of the file that contains the ThreateIntelSet.
", - "smithy.api#jsonName": "location" - } - }, - "Activate": { - "target": "com.amazonaws.guardduty#Boolean", - "traits": { - "smithy.api#documentation": "The updated Boolean value that specifies whether the ThreateIntelSet is active or\n not.
", - "smithy.api#jsonName": "activate" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.guardduty#UpdateThreatIntelSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.guardduty#UsageAccountResult": { - "type": "structure", - "members": { - "AccountId": { - "target": "com.amazonaws.guardduty#AccountId", - "traits": { - "smithy.api#documentation": "The Account ID that generated usage.
", - "smithy.api#jsonName": "accountId" - } - }, - "Total": { - "target": "com.amazonaws.guardduty#Total", - "traits": { - "smithy.api#documentation": "Represents the total of usage for the Account ID.
", - "smithy.api#jsonName": "total" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the total of usage based on account IDs.
" - } - }, - "com.amazonaws.guardduty#UsageAccountResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#UsageAccountResult" - } - }, - "com.amazonaws.guardduty#UsageCriteria": { - "type": "structure", - "members": { - "AccountIds": { - "target": "com.amazonaws.guardduty#AccountIds", - "traits": { - "smithy.api#documentation": "The account IDs to aggregate usage statistics from.
", - "smithy.api#jsonName": "accountIds" - } - }, - "DataSources": { - "target": "com.amazonaws.guardduty#DataSourceList", - "traits": { - "smithy.api#deprecated": { - "message": "This parameter is deprecated, use Features instead" - }, - "smithy.api#documentation": "The data sources to aggregate usage statistics from.
", - "smithy.api#jsonName": "dataSources" - } - }, - "Resources": { - "target": "com.amazonaws.guardduty#ResourceList", - "traits": { - "smithy.api#documentation": "The resources to aggregate usage statistics from. Only accepts exact resource\n names.
", - "smithy.api#jsonName": "resources" - } - }, - "Features": { - "target": "com.amazonaws.guardduty#UsageFeatureList", - "traits": { - "smithy.api#documentation": "The features to aggregate usage statistics from.
", - "smithy.api#jsonName": "features" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the criteria used to query usage statistics.
" - } - }, - "com.amazonaws.guardduty#UsageDataSourceResult": { - "type": "structure", - "members": { - "DataSource": { - "target": "com.amazonaws.guardduty#DataSource", - "traits": { - "smithy.api#documentation": "The data source type that generated usage.
", - "smithy.api#jsonName": "dataSource" - } - }, - "Total": { - "target": "com.amazonaws.guardduty#Total", - "traits": { - "smithy.api#documentation": "Represents the total of usage for the specified data source.
", - "smithy.api#jsonName": "total" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the result of usage based on data source type.
" - } - }, - "com.amazonaws.guardduty#UsageDataSourceResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#UsageDataSourceResult" - } - }, - "com.amazonaws.guardduty#UsageFeature": { - "type": "enum", - "members": { - "FLOW_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLOW_LOGS" - } - }, - "CLOUD_TRAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUD_TRAIL" - } - }, - "DNS_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DNS_LOGS" - } - }, - "S3_DATA_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_DATA_EVENTS" - } - }, - "EKS_AUDIT_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_AUDIT_LOGS" - } - }, - "EBS_MALWARE_PROTECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EBS_MALWARE_PROTECTION" - } - }, - "RDS_LOGIN_EVENTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDS_LOGIN_EVENTS" - } - }, - "LAMBDA_NETWORK_LOGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAMBDA_NETWORK_LOGS" - } - }, - "EKS_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EKS_RUNTIME_MONITORING" - } - }, - "FARGATE_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FARGATE_RUNTIME_MONITORING" - } - }, - "EC2_RUNTIME_MONITORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EC2_RUNTIME_MONITORING" - } - } - } - }, - "com.amazonaws.guardduty#UsageFeatureList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#UsageFeature" - } - }, - "com.amazonaws.guardduty#UsageFeatureResult": { - "type": "structure", - "members": { - "Feature": { - "target": "com.amazonaws.guardduty#UsageFeature", - "traits": { - "smithy.api#documentation": "The feature that generated the usage cost.
", - "smithy.api#jsonName": "feature" - } - }, - "Total": { - "target": "com.amazonaws.guardduty#Total", - "traits": { - "smithy.api#jsonName": "total" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the result of the total usage based on the feature.
" - } - }, - "com.amazonaws.guardduty#UsageFeatureResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#UsageFeatureResult" - } - }, - "com.amazonaws.guardduty#UsageResourceResult": { - "type": "structure", - "members": { - "Resource": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services resource that generated usage.
", - "smithy.api#jsonName": "resource" - } - }, - "Total": { - "target": "com.amazonaws.guardduty#Total", - "traits": { - "smithy.api#documentation": "Represents the sum total of usage for the specified resource type.
", - "smithy.api#jsonName": "total" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information on the sum of usage based on an Amazon Web Services resource.
" - } - }, - "com.amazonaws.guardduty#UsageResourceResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#UsageResourceResult" - } - }, - "com.amazonaws.guardduty#UsageStatisticType": { - "type": "enum", - "members": { - "SUM_BY_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM_BY_ACCOUNT" - } - }, - "SUM_BY_DATA_SOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM_BY_DATA_SOURCE" - } - }, - "SUM_BY_RESOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM_BY_RESOURCE" - } - }, - "TOP_RESOURCES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP_RESOURCES" - } - }, - "SUM_BY_FEATURES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM_BY_FEATURES" - } - } - } - }, - "com.amazonaws.guardduty#UsageStatistics": { - "type": "structure", - "members": { - "SumByAccount": { - "target": "com.amazonaws.guardduty#UsageAccountResultList", - "traits": { - "smithy.api#documentation": "The usage statistic sum organized by account ID.
", - "smithy.api#jsonName": "sumByAccount" - } - }, - "SumByDataSource": { - "target": "com.amazonaws.guardduty#UsageDataSourceResultList", - "traits": { - "smithy.api#documentation": "The usage statistic sum organized by on data source.
", - "smithy.api#jsonName": "sumByDataSource" - } - }, - "SumByResource": { - "target": "com.amazonaws.guardduty#UsageResourceResultList", - "traits": { - "smithy.api#documentation": "The usage statistic sum organized by resource.
", - "smithy.api#jsonName": "sumByResource" - } - }, - "TopResources": { - "target": "com.amazonaws.guardduty#UsageResourceResultList", - "traits": { - "smithy.api#documentation": "Lists the top 50 resources that have generated the most GuardDuty usage, in order from\n most to least expensive.
", - "smithy.api#jsonName": "topResources" - } - }, - "SumByFeature": { - "target": "com.amazonaws.guardduty#UsageFeatureResultList", - "traits": { - "smithy.api#documentation": "The usage statistic sum organized by feature.
", - "smithy.api#jsonName": "sumByFeature" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the result of GuardDuty usage. If a UsageStatisticType is provided the result for\n other types will be null.
" - } - }, - "com.amazonaws.guardduty#Volume": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Volume name.
", - "smithy.api#jsonName": "name" - } - }, - "HostPath": { - "target": "com.amazonaws.guardduty#HostPath", - "traits": { - "smithy.api#documentation": "Represents a pre-existing file or directory on the host machine that the volume maps\n to.
", - "smithy.api#jsonName": "hostPath" - } - } - }, - "traits": { - "smithy.api#documentation": "Volume used by the Kubernetes workload.
" - } - }, - "com.amazonaws.guardduty#VolumeDetail": { - "type": "structure", - "members": { - "VolumeArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "EBS volume Arn information.
", - "smithy.api#jsonName": "volumeArn" - } - }, - "VolumeType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The EBS volume type.
", - "smithy.api#jsonName": "volumeType" - } - }, - "DeviceName": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The device name for the EBS volume.
", - "smithy.api#jsonName": "deviceName" - } - }, - "VolumeSizeInGB": { - "target": "com.amazonaws.guardduty#Integer", - "traits": { - "smithy.api#documentation": "EBS volume size in GB.
", - "smithy.api#jsonName": "volumeSizeInGB" - } - }, - "EncryptionType": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "EBS volume encryption type.
", - "smithy.api#jsonName": "encryptionType" - } - }, - "SnapshotArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Snapshot Arn of the EBS volume.
", - "smithy.api#jsonName": "snapshotArn" - } - }, - "KmsKeyArn": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "KMS key Arn used to encrypt the EBS volume.
", - "smithy.api#jsonName": "kmsKeyArn" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains EBS volume details.
" - } - }, - "com.amazonaws.guardduty#VolumeDetails": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#VolumeDetail" - } - }, - "com.amazonaws.guardduty#VolumeMount": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Volume mount name.
", - "smithy.api#jsonName": "name" - } - }, - "MountPath": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "Volume mount path.
", - "smithy.api#jsonName": "mountPath" - } - } - }, - "traits": { - "smithy.api#documentation": "Container volume mount.
" - } - }, - "com.amazonaws.guardduty#VolumeMounts": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#VolumeMount" - } - }, - "com.amazonaws.guardduty#Volumes": { - "type": "list", - "member": { - "target": "com.amazonaws.guardduty#Volume" - } - }, - "com.amazonaws.guardduty#VpcConfig": { - "type": "structure", - "members": { - "SubnetIds": { - "target": "com.amazonaws.guardduty#SubnetIds", - "traits": { - "smithy.api#documentation": "The identifiers of the subnets that are associated with your Lambda function.
", - "smithy.api#jsonName": "subnetIds" - } - }, - "VpcId": { - "target": "com.amazonaws.guardduty#String", - "traits": { - "smithy.api#documentation": "The identifier of the Amazon Virtual Private Cloud.
", - "smithy.api#jsonName": "vpcId" - } - }, - "SecurityGroups": { - "target": "com.amazonaws.guardduty#SecurityGroups", - "traits": { - "smithy.api#documentation": "The identifier of the security group attached to the Lambda function.
", - "smithy.api#jsonName": "securityGroups" - } } - }, - "traits": { - "smithy.api#documentation": "Amazon Virtual Private Cloud configuration details associated with your Lambda function.
" - } } - } } diff --git a/codegen/sdk-codegen/aws-models/managedblockchain-query.json b/codegen/sdk-codegen/aws-models/managedblockchain-query.json index 8e1a007803bc7..08fae10dbef2a 100644 --- a/codegen/sdk-codegen/aws-models/managedblockchain-query.json +++ b/codegen/sdk-codegen/aws-models/managedblockchain-query.json @@ -1,2609 +1,2649 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.managedblockchainquery#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", - "traits": { - "smithy.api#documentation": "The container for the exception message.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The Amazon Web Services account doesn’t have access to this resource.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.managedblockchainquery#AssetContract": { - "type": "structure", - "members": { - "contractIdentifier": { - "target": "com.amazonaws.managedblockchainquery#ContractIdentifier", - "traits": { - "smithy.api#documentation": "The container for the contract identifier containing its blockchain network \n and address.
", - "smithy.api#required": {} - } - }, - "tokenStandard": { - "target": "com.amazonaws.managedblockchainquery#QueryTokenStandard", - "traits": { - "smithy.api#documentation": "The token standard of the contract.
", - "smithy.api#required": {} - } - }, - "deployerAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The address of the contract deployer.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "This container contains information about an contract.
" - } - }, - "com.amazonaws.managedblockchainquery#AssetContractList": { - "type": "list", - "member": { - "target": "com.amazonaws.managedblockchainquery#AssetContract" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.managedblockchainquery#BatchGetTokenBalance": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to batch calls for GetTokenBalance API", - "smithy.api#documentation": "Gets the token balance for a batch of tokens by using the BatchGetTokenBalance \n action for every token in the request.
Only the native tokens BTC,ETH, and the ERC-20, \n ERC-721, and ERC 1155 token standards are supported.
\nThe error code associated with the error.
", - "smithy.api#required": {} - } - }, - "errorMessage": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The message associated with the error.
", - "smithy.api#required": {} - } - }, - "errorType": { - "target": "com.amazonaws.managedblockchainquery#ErrorType", - "traits": { - "smithy.api#documentation": "The type of error.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Error generated from a failed BatchGetTokenBalance request.
An array of BatchGetTokenBalanceInputItem objects whose balance is being requested.
The container for the input for getting a token balance.
" - } - }, - "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutput": { - "type": "structure", - "members": { - "tokenBalances": { - "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutputList", - "traits": { - "smithy.api#documentation": "An array of BatchGetTokenBalanceOutputItem objects returned by the response.
An array of BatchGetTokenBalanceErrorItem objects returned from the request.
The container for the token balance.
", - "smithy.api#required": {} - } - }, - "atBlockchainInstant": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", - "traits": { - "smithy.api#required": {} - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" - } - }, - "traits": { - "smithy.api#documentation": "The container for the properties of a token balance output.
" - } - }, - "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutputList": { - "type": "list", - "member": { - "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutputItem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.managedblockchainquery#BlockHash": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})$" - } - }, - "com.amazonaws.managedblockchainquery#BlockchainInstant": { - "type": "structure", - "members": { - "time": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The container of the Timestamp of the blockchain instant.
This timestamp will only be recorded up to \n the second.
The container for time.
" - } - }, - "com.amazonaws.managedblockchainquery#ChainAddress": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[-A-Za-z0-9]{13,74}$" - } - }, - "com.amazonaws.managedblockchainquery#ContractFilter": { - "type": "structure", - "members": { - "network": { - "target": "com.amazonaws.managedblockchainquery#QueryNetwork", - "traits": { - "smithy.api#documentation": "The blockchain network of the contract.
", - "smithy.api#required": {} - } - }, - "tokenStandard": { - "target": "com.amazonaws.managedblockchainquery#QueryTokenStandard", - "traits": { - "smithy.api#documentation": "The container for the token standard.
", - "smithy.api#required": {} - } - }, - "deployerAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The network address of the deployer.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The contract or wallet address by which to filter the request.
" - } - }, - "com.amazonaws.managedblockchainquery#ContractIdentifier": { - "type": "structure", - "members": { - "network": { - "target": "com.amazonaws.managedblockchainquery#QueryNetwork", - "traits": { - "smithy.api#documentation": "The blockchain network of the contract.
", - "smithy.api#required": {} - } - }, - "contractAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "Container for the blockchain address about a contract.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Container for the blockchain address and network information about a contract.
" - } - }, - "com.amazonaws.managedblockchainquery#ContractMetadata": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The name of the token contract.
" - } - }, - "symbol": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The symbol of the token contract.
" - } - }, - "decimals": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The decimals used by the token contract.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The metadata of the contract.
" - } - }, - "com.amazonaws.managedblockchainquery#ErrorType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "VALIDATION_EXCEPTION", - "name": "VALIDATION_EXCEPTION", - "documentation": "An API request validation exception" - }, - { - "value": "RESOURCE_NOT_FOUND_EXCEPTION", - "name": "RESOURCE_NOT_FOUND_EXCEPTION", - "documentation": "An API request retrieving an item that can't be found" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#ExceptionMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.managedblockchainquery#GetAssetContract": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#GetAssetContractInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#GetAssetContractOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to fetch information about a contract on the blockchain", - "smithy.api#documentation": "Gets the information about a specific contract deployed on the blockchain.
\nThe Bitcoin blockchain networks do not support this \n operation.
\nMetadata is currently only available for some ERC-20 contracts. \n Metadata will be available for additional contracts in the future.
Contains the blockchain address and network information about the contract.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.managedblockchainquery#GetAssetContractOutput": { - "type": "structure", - "members": { - "contractIdentifier": { - "target": "com.amazonaws.managedblockchainquery#ContractIdentifier", - "traits": { - "smithy.api#documentation": "Contains the blockchain address and network information about the contract.
", - "smithy.api#required": {} - } - }, - "tokenStandard": { - "target": "com.amazonaws.managedblockchainquery#QueryTokenStandard", - "traits": { - "smithy.api#documentation": "The token standard of the contract requested.
", - "smithy.api#required": {} - } - }, - "deployerAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The address of the deployer of contract.
", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.managedblockchainquery#ContractMetadata" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.managedblockchainquery#GetTokenBalance": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#GetTokenBalanceInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#GetTokenBalanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve balance of a token for an address on the blockchain", - "smithy.api#documentation": "Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.
\nOnly the native tokens BTC,ETH, and the ERC-20, \n ERC-721, and ERC 1155 token standards are supported.
\nThe container for the identifier for the token, including the unique \n token ID and its blockchain network.
", - "smithy.api#required": {} - } - }, - "ownerIdentifier": { - "target": "com.amazonaws.managedblockchainquery#OwnerIdentifier", - "traits": { - "smithy.api#documentation": "The container for the identifier for the owner.
", - "smithy.api#required": {} - } - }, - "atBlockchainInstant": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", - "traits": { - "smithy.api#documentation": "The time for when the TokenBalance is requested or \n the current time if a time is not provided in the request.
\nThis time will only be recorded up to the second.
\nThe container for the token balance.
", - "smithy.api#required": {} - } - }, - "atBlockchainInstant": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", - "traits": { - "smithy.api#required": {} - } - }, - "lastUpdatedTime": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.managedblockchainquery#GetTransaction": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#GetTransactionInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#GetTransactionOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve a transaction on the blockchain", - "smithy.api#documentation": "Get the details of a transaction.
", - "smithy.api#http": { - "uri": "/get-transaction", - "method": "POST" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.managedblockchainquery#GetTransactionInput": { - "type": "structure", - "members": { - "transactionHash": { - "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", - "traits": { - "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", - "smithy.api#required": {} - } - }, - "network": { - "target": "com.amazonaws.managedblockchainquery#QueryNetwork", - "traits": { - "smithy.api#documentation": "The blockchain network where the transaction occurred.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.managedblockchainquery#GetTransactionOutput": { - "type": "structure", - "members": { - "transaction": { - "target": "com.amazonaws.managedblockchainquery#Transaction", - "traits": { - "smithy.api#documentation": "Contains the details of the transaction.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.managedblockchainquery#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", - "traits": { - "smithy.api#documentation": "The container for the exception message.
", - "smithy.api#required": {} - } - }, - "retryAfterSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The container of the retryAfterSeconds value.
The request processing has failed because of an internal error in the service.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500, - "smithy.api#retryable": {} - } - }, - "com.amazonaws.managedblockchainquery#ListAssetContracts": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#ListAssetContractsInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#ListAssetContractsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to fetch multiple contracts on the blockchain", - "smithy.api#documentation": "Lists all the contracts for a given contract type deployed by an address \n (either a contract address or a wallet address).
\nThe Bitcoin blockchain networks do not support this \n operation.
", - "smithy.api#http": { - "uri": "/list-asset-contracts", - "method": "POST" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "contracts", - "pageSize": "maxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.managedblockchainquery#ListAssetContractsInput": { - "type": "structure", - "members": { - "contractFilter": { - "target": "com.amazonaws.managedblockchainquery#ContractFilter", - "traits": { - "smithy.api#documentation": "Contains the filter parameter for the request.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.managedblockchainquery#NextToken", - "traits": { - "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of contracts to list.
", - "smithy.api#range": { - "min": 1, - "max": 250 - } - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.managedblockchainquery#ListAssetContractsOutput": { - "type": "structure", - "members": { - "contracts": { - "target": "com.amazonaws.managedblockchainquery#AssetContractList", - "traits": { - "smithy.api#documentation": "An array of contract objects that contain the properties for each contract.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.managedblockchainquery#NextToken", - "traits": { - "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.managedblockchainquery#ListTokenBalances": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#ListTokenBalancesInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#ListTokenBalancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve multiple balances on the blockchain", - "smithy.api#documentation": "This action returns the following for a given blockchain network:
\nLists all token balances owned by an address (either a contract \n address or a wallet address).
\nLists all token balances for all tokens created by a contract.
\nLists all token balances for a given token.
\nYou must always specify the network property of \n the tokenFilter when using this operation.
The contract or wallet address on the blockchain network by which to filter the \n request. You must specify the address property of the ownerFilter \n when listing balances of tokens owned by the address.
The contract address or a token identifier on the \n blockchain network by which to filter the request. You must specify the contractAddress \n property of this container when listing tokens minted by a contract.
You must always specify the network property of this \n container when using this operation.
\nThe pagination token that indicates the next set of results to retrieve.
" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of token balances to return.
", - "smithy.api#range": { - "min": 1, - "max": 250 - } - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.managedblockchainquery#ListTokenBalancesOutput": { - "type": "structure", - "members": { - "tokenBalances": { - "target": "com.amazonaws.managedblockchainquery#TokenBalanceList", - "traits": { - "smithy.api#documentation": "An array of TokenBalance objects. Each object contains details about \n the token balance.
The pagination token that indicates the next set of results to retrieve.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.managedblockchainquery#ListTransactionEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#ListTransactionEventsInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#ListTransactionEventsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve events in a transaction on the blockchain", - "smithy.api#documentation": "An array of TransactionEvent objects. Each object contains details \n about the transaction event.
The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", - "smithy.api#required": {} - } - }, - "network": { - "target": "com.amazonaws.managedblockchainquery#QueryNetwork", - "traits": { - "smithy.api#documentation": "The blockchain network where the transaction events occurred.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.managedblockchainquery#NextToken", - "traits": { - "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of transaction events to list.
\nEven if additional results can be retrieved, the request can return less \n results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the \n returned nextToken value. The value of nextToken is \n null when there are no more results to return
An array of TransactionEvent objects. Each object contains details \n about the transaction events.
The pagination token that indicates the next set of results to retrieve.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.managedblockchainquery#ListTransactions": { - "type": "operation", - "input": { - "target": "com.amazonaws.managedblockchainquery#ListTransactionsInput" - }, - "output": { - "target": "com.amazonaws.managedblockchainquery#ListTransactionsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" - }, - { - "target": "com.amazonaws.managedblockchainquery#InternalServerException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ThrottlingException" - }, - { - "target": "com.amazonaws.managedblockchainquery#ValidationException" - } - ], - "traits": { - "aws.iam#actionPermissionDescription": "Grants permission to retrieve a multiple transactions on a blockchain", - "smithy.api#documentation": "Lists all of the transactions on a given wallet address or to a specific contract.
", - "smithy.api#http": { - "uri": "/list-transactions", - "method": "POST" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "transactions", - "pageSize": "maxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.managedblockchainquery#ListTransactionsInput": { - "type": "structure", - "members": { - "address": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The address (either a contract or wallet), whose transactions are being requested.
", - "smithy.api#required": {} - } - }, - "network": { - "target": "com.amazonaws.managedblockchainquery#QueryNetwork", - "traits": { - "smithy.api#documentation": "The blockchain network where the transactions occurred.
", - "smithy.api#required": {} - } - }, - "fromBlockchainInstant": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" - }, - "toBlockchainInstant": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" - }, - "sort": { - "target": "com.amazonaws.managedblockchainquery#ListTransactionsSort", - "traits": { - "smithy.api#documentation": "Sorts items in an ascending order if the first page starts at fromTime. \n Sorts items in a descending order if the first page starts at toTime.
The pagination token that indicates the next set of results to retrieve.
" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of transactions to list.
\nEven if additional results can be retrieved, the request can return less \n results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the \n returned nextToken value. The value of nextToken is \n null when there are no more results to return
The array of transactions returned by the request.
", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.managedblockchainquery#NextToken", - "traits": { - "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.managedblockchainquery#ListTransactionsSort": { - "type": "structure", - "members": { - "sortBy": { - "target": "com.amazonaws.managedblockchainquery#ListTransactionsSortBy", - "traits": { - "smithy.api#documentation": "Defaults to the value TRANSACTION_TIMESTAMP.
The container for the sort order for ListTransactions. \n The SortOrder field only accepts the values ASCENDING \n and DESCENDING. Not providing SortOrder will default \n to ASCENDING.
The container for determining how the list transaction result will \n be sorted.
" - } - }, - "com.amazonaws.managedblockchainquery#ListTransactionsSortBy": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "TRANSACTION_TIMESTAMP", - "name": "TRANSACTION_TIMESTAMP", - "documentation": "Timestamp of a transaction" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 131070 - } - } - }, - "com.amazonaws.managedblockchainquery#OwnerFilter": { - "type": "structure", - "members": { - "address": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The contract or wallet address.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The container for the owner information to filter by.
" - } - }, - "com.amazonaws.managedblockchainquery#OwnerIdentifier": { - "type": "structure", - "members": { - "address": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The contract or wallet address for the owner.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The container for the identifier of the owner.
" - } - }, - "com.amazonaws.managedblockchainquery#QueryNetwork": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ETHEREUM_MAINNET", - "name": "ETHEREUM_MAINNET", - "documentation": "Ethereum main network" - }, - { - "value": "BITCOIN_MAINNET", - "name": "BITCOIN_MAINNET", - "documentation": "Bitcoin main network" - }, - { - "value": "BITCOIN_TESTNET", - "name": "BITCOIN_TESTNET", - "documentation": "Bitcoin test network" - }, - { - "value": "ETHEREUM_SEPOLIA_TESTNET", - "name": "ETHEREUM_SEPOLIA_TESTNET", - "documentation": "SEPOLIA network (ethereum testnet)" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#QueryTokenId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9]{1,66}$" - } - }, - "com.amazonaws.managedblockchainquery#QueryTokenStandard": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ERC20", - "name": "ERC20" - }, - { - "value": "ERC721", - "name": "ERC721" - }, - { - "value": "ERC1155", - "name": "ERC1155" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#QueryTransactionEventType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ERC20_TRANSFER", - "name": "ERC20_TRANSFER", - "documentation": "An ERC20 transfer type" - }, - { - "value": "ERC20_MINT", - "name": "ERC20_MINT", - "documentation": "An ERC20_MINT transfer type" - }, - { - "value": "ERC20_BURN", - "name": "ERC20_BURN", - "documentation": "An ERC20_BURN transfer type" - }, - { - "value": "ERC20_DEPOSIT", - "name": "ERC20_DEPOSIT", - "documentation": "An ERC20_DEPOSIT transfer type" - }, - { - "value": "ERC20_WITHDRAWAL", - "name": "ERC20_WITHDRAWAL", - "documentation": "An ERC20_WITHDRAWAL transfer type" - }, - { - "value": "ERC721_TRANSFER", - "name": "ERC721_TRANSFER", - "documentation": "An ERC721 transfer type" - }, - { - "value": "ERC1155_TRANSFER", - "name": "ERC1155_TRANSFER", - "documentation": "An ERC1155 transfer type" - }, - { - "value": "BITCOIN_VIN", - "name": "BITCOIN_VIN", - "documentation": "A Bitcoin Vin transfer type" - }, - { - "value": "BITCOIN_VOUT", - "name": "BITCOIN_VOUT", - "documentation": "A Bitcoin Vout transfer type" - }, - { - "value": "INTERNAL_ETH_TRANSFER", - "name": "INTERNAL_ETH_TRANSFER", - "documentation": "An internal ETH transfer type" - }, - { - "value": "ETH_TRANSFER", - "name": "ETH_TRANSFER", - "documentation": "An ETH transfer type" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#QueryTransactionHash": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})$" - } - }, - "com.amazonaws.managedblockchainquery#QueryTransactionStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FINAL", - "name": "FINAL", - "documentation": "The transaction has been confirmed and is final in the blockchain" - }, - { - "value": "FAILED", - "name": "FAILED", - "documentation": "The transaction completed on the blockchain, but failed" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#QuotaCode": { - "type": "string" - }, - "com.amazonaws.managedblockchainquery#ResourceId": { - "type": "string" - }, - "com.amazonaws.managedblockchainquery#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", - "traits": { - "smithy.api#documentation": "The container for the exception message.
", - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "com.amazonaws.managedblockchainquery#ResourceId", - "traits": { - "smithy.api#documentation": "The resourceId of the resource that caused the exception.
The resourceType of the resource that caused the exception.
The resource was not found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.managedblockchainquery#ResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "collection", - "name": "COLLECTION" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#ServiceCode": { - "type": "string" - }, - "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", - "traits": { - "smithy.api#documentation": "The container for the exception message.
", - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "com.amazonaws.managedblockchainquery#ResourceId", - "traits": { - "smithy.api#documentation": "The resourceId of the resource that caused the exception.
The resourceType of the resource that caused the exception.
The container for the serviceCode.
The container for the quotaCode.
The service quota has been exceeded for this resource.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.managedblockchainquery#SortOrder": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ASCENDING", - "name": "ASCENDING", - "documentation": "Result sorted in ascending order" - }, - { - "value": "DESCENDING", - "name": "DESCENDING", - "documentation": "Result sorted in descending order" - } - ] - } - }, - "com.amazonaws.managedblockchainquery#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", - "traits": { - "smithy.api#documentation": "The container for the exception message.
", - "smithy.api#required": {} - } - }, - "serviceCode": { - "target": "com.amazonaws.managedblockchainquery#ServiceCode", - "traits": { - "smithy.api#documentation": "The container for the serviceCode.
The container for the quotaCode.
The container of the retryAfterSeconds value.
The request or operation couldn't be performed because a service is throttling \n requests. The most common source of throttling errors is when you create resources \n that exceed your service limit for this resource type. Request a limit increase or \n delete unused resources, if possible.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429, - "smithy.api#retryable": { - "throttling": true - } - } - }, - "com.amazonaws.managedblockchainquery#TietonChainQueryService": { - "type": "service", - "version": "2023-05-04", - "operations": [ - { - "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalance" + "smithy": "2.0", + "shapes": { + "com.amazonaws.managedblockchainquery#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The container for the exception message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Web Services account doesn’t have access to this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.managedblockchainquery#AssetContract": { + "type": "structure", + "members": { + "contractIdentifier": { + "target": "com.amazonaws.managedblockchainquery#ContractIdentifier", + "traits": { + "smithy.api#documentation": "The container for the contract identifier containing its blockchain network \n and address.
", + "smithy.api#required": {} + } + }, + "tokenStandard": { + "target": "com.amazonaws.managedblockchainquery#QueryTokenStandard", + "traits": { + "smithy.api#documentation": "The token standard of the contract.
", + "smithy.api#required": {} + } + }, + "deployerAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The address of the contract deployer.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This container contains information about an contract.
" + } + }, + "com.amazonaws.managedblockchainquery#AssetContractList": { + "type": "list", + "member": { + "target": "com.amazonaws.managedblockchainquery#AssetContract" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.managedblockchainquery#BatchGetTokenBalance": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to batch calls for GetTokenBalance API", + "smithy.api#documentation": "Gets the token balance for a batch of tokens by using the BatchGetTokenBalance \n action for every token in the request.
Only the native tokens BTC,ETH, and the ERC-20, \n ERC-721, and ERC 1155 token standards are supported.
\nThe error code associated with the error.
", + "smithy.api#required": {} + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The message associated with the error.
", + "smithy.api#required": {} + } + }, + "errorType": { + "target": "com.amazonaws.managedblockchainquery#ErrorType", + "traits": { + "smithy.api#documentation": "The type of error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Error generated from a failed BatchGetTokenBalance request.
An array of BatchGetTokenBalanceInputItem objects whose balance is being requested.
The container for the input for getting a token balance.
" + } + }, + "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutput": { + "type": "structure", + "members": { + "tokenBalances": { + "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutputList", + "traits": { + "smithy.api#documentation": "An array of BatchGetTokenBalanceOutputItem objects returned by the response.
An array of BatchGetTokenBalanceErrorItem objects returned from the request.
The container for the token balance.
", + "smithy.api#required": {} + } + }, + "atBlockchainInstant": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", + "traits": { + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" + } + }, + "traits": { + "smithy.api#documentation": "The container for the properties of a token balance output.
" + } + }, + "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalanceOutputItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.managedblockchainquery#BlockHash": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})$" + } + }, + "com.amazonaws.managedblockchainquery#BlockchainInstant": { + "type": "structure", + "members": { + "time": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The container of the Timestamp of the blockchain instant.
This timestamp will only be recorded up to \n the second.
The container for time.
" + } + }, + "com.amazonaws.managedblockchainquery#ChainAddress": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[-A-Za-z0-9]{13,74}$" + } + }, + "com.amazonaws.managedblockchainquery#ConfirmationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FINAL", + "name": "FINAL" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#ContractFilter": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.managedblockchainquery#QueryNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network of the contract.
", + "smithy.api#required": {} + } + }, + "tokenStandard": { + "target": "com.amazonaws.managedblockchainquery#QueryTokenStandard", + "traits": { + "smithy.api#documentation": "The container for the token standard.
", + "smithy.api#required": {} + } + }, + "deployerAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The network address of the deployer.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The contract or wallet address by which to filter the request.
" + } + }, + "com.amazonaws.managedblockchainquery#ContractIdentifier": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.managedblockchainquery#QueryNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network of the contract.
", + "smithy.api#required": {} + } + }, + "contractAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "Container for the blockchain address about a contract.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the blockchain address and network information about a contract.
" + } + }, + "com.amazonaws.managedblockchainquery#ContractMetadata": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the token contract.
" + } + }, + "symbol": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The symbol of the token contract.
" + } + }, + "decimals": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The decimals used by the token contract.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The metadata of the contract.
" + } + }, + "com.amazonaws.managedblockchainquery#ErrorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "VALIDATION_EXCEPTION", + "name": "VALIDATION_EXCEPTION", + "documentation": "An API request validation exception" + }, + { + "value": "RESOURCE_NOT_FOUND_EXCEPTION", + "name": "RESOURCE_NOT_FOUND_EXCEPTION", + "documentation": "An API request retrieving an item that can't be found" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#ExceptionMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.managedblockchainquery#ExecutionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#GetAssetContract": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#GetAssetContractInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#GetAssetContractOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to fetch information about a contract on the blockchain", + "smithy.api#documentation": "Gets the information about a specific contract deployed on the blockchain.
\nThe Bitcoin blockchain networks do not support this \n operation.
\nMetadata is currently only available for some ERC-20 contracts. \n Metadata will be available for additional contracts in the future.
Contains the blockchain address and network information about the contract.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.managedblockchainquery#GetAssetContractOutput": { + "type": "structure", + "members": { + "contractIdentifier": { + "target": "com.amazonaws.managedblockchainquery#ContractIdentifier", + "traits": { + "smithy.api#documentation": "Contains the blockchain address and network information about the contract.
", + "smithy.api#required": {} + } + }, + "tokenStandard": { + "target": "com.amazonaws.managedblockchainquery#QueryTokenStandard", + "traits": { + "smithy.api#documentation": "The token standard of the contract requested.
", + "smithy.api#required": {} + } + }, + "deployerAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The address of the deployer of contract.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.managedblockchainquery#ContractMetadata" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.managedblockchainquery#GetTokenBalance": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#GetTokenBalanceInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#GetTokenBalanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve balance of a token for an address on the blockchain", + "smithy.api#documentation": "Gets the balance of a specific token, including native tokens, for a given address (wallet or contract) on the blockchain.
\nOnly the native tokens BTC,ETH, and the ERC-20, \n ERC-721, and ERC 1155 token standards are supported.
\nThe container for the identifier for the token, including the unique \n token ID and its blockchain network.
", + "smithy.api#required": {} + } + }, + "ownerIdentifier": { + "target": "com.amazonaws.managedblockchainquery#OwnerIdentifier", + "traits": { + "smithy.api#documentation": "The container for the identifier for the owner.
", + "smithy.api#required": {} + } + }, + "atBlockchainInstant": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", + "traits": { + "smithy.api#documentation": "The time for when the TokenBalance is requested or \n the current time if a time is not provided in the request.
\nThis time will only be recorded up to the second.
\nThe container for the token balance.
", + "smithy.api#required": {} + } + }, + "atBlockchainInstant": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", + "traits": { + "smithy.api#required": {} + } + }, + "lastUpdatedTime": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.managedblockchainquery#GetTransaction": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#GetTransactionInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#GetTransactionOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve a transaction on the blockchain", + "smithy.api#documentation": "Get the details of a transaction.
", + "smithy.api#http": { + "uri": "/get-transaction", + "method": "POST" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.managedblockchainquery#GetTransactionInput": { + "type": "structure", + "members": { + "transactionHash": { + "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", + "traits": { + "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", + "smithy.api#required": {} + } + }, + "network": { + "target": "com.amazonaws.managedblockchainquery#QueryNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network where the transaction occurred.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.managedblockchainquery#GetTransactionOutput": { + "type": "structure", + "members": { + "transaction": { + "target": "com.amazonaws.managedblockchainquery#Transaction", + "traits": { + "smithy.api#documentation": "Contains the details of the transaction.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.managedblockchainquery#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The container for the exception message.
", + "smithy.api#required": {} + } + }, + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The container of the retryAfterSeconds value.
The request processing has failed because of an internal error in the service.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.managedblockchainquery#ListAssetContracts": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#ListAssetContractsInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#ListAssetContractsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to fetch multiple contracts on the blockchain", + "smithy.api#documentation": "Lists all the contracts for a given contract type deployed by an address \n (either a contract address or a wallet address).
\nThe Bitcoin blockchain networks do not support this \n operation.
", + "smithy.api#http": { + "uri": "/list-asset-contracts", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "contracts", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.managedblockchainquery#ListAssetContractsInput": { + "type": "structure", + "members": { + "contractFilter": { + "target": "com.amazonaws.managedblockchainquery#ContractFilter", + "traits": { + "smithy.api#documentation": "Contains the filter parameter for the request.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.managedblockchainquery#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of contracts to list.
", + "smithy.api#range": { + "min": 1, + "max": 250 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.managedblockchainquery#ListAssetContractsOutput": { + "type": "structure", + "members": { + "contracts": { + "target": "com.amazonaws.managedblockchainquery#AssetContractList", + "traits": { + "smithy.api#documentation": "An array of contract objects that contain the properties for each contract.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.managedblockchainquery#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.managedblockchainquery#ListTokenBalances": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#ListTokenBalancesInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#ListTokenBalancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve multiple balances on the blockchain", + "smithy.api#documentation": "This action returns the following for a given blockchain network:
\nLists all token balances owned by an address (either a contract \n address or a wallet address).
\nLists all token balances for all tokens created by a contract.
\nLists all token balances for a given token.
\nYou must always specify the network property of \n the tokenFilter when using this operation.
The contract or wallet address on the blockchain network by which to filter the \n request. You must specify the address property of the ownerFilter \n when listing balances of tokens owned by the address.
The contract address or a token identifier on the \n blockchain network by which to filter the request. You must specify the contractAddress \n property of this container when listing tokens minted by a contract.
You must always specify the network property of this \n container when using this operation.
\nThe pagination token that indicates the next set of results to retrieve.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of token balances to return.
", + "smithy.api#range": { + "min": 1, + "max": 250 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.managedblockchainquery#ListTokenBalancesOutput": { + "type": "structure", + "members": { + "tokenBalances": { + "target": "com.amazonaws.managedblockchainquery#TokenBalanceList", + "traits": { + "smithy.api#documentation": "An array of TokenBalance objects. Each object contains details about \n the token balance.
The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.managedblockchainquery#ListTransactionEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#ListTransactionEventsInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#ListTransactionEventsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve events in a transaction on the blockchain", + "smithy.api#documentation": "An array of TransactionEvent objects. Each object contains details \n about the transaction event.
The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", + "smithy.api#required": {} + } + }, + "network": { + "target": "com.amazonaws.managedblockchainquery#QueryNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network where the transaction events occurred.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.managedblockchainquery#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of transaction events to list.
\nEven if additional results can be retrieved, the request can return less \n results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the \n returned nextToken value. The value of nextToken is \n null when there are no more results to return
An array of TransactionEvent objects. Each object contains details \n about the transaction events.
The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.managedblockchainquery#ListTransactions": { + "type": "operation", + "input": { + "target": "com.amazonaws.managedblockchainquery#ListTransactionsInput" + }, + "output": { + "target": "com.amazonaws.managedblockchainquery#ListTransactionsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.managedblockchainquery#AccessDeniedException" + }, + { + "target": "com.amazonaws.managedblockchainquery#InternalServerException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ThrottlingException" + }, + { + "target": "com.amazonaws.managedblockchainquery#ValidationException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve a multiple transactions on a blockchain", + "smithy.api#documentation": "Lists all of the transactions on a given wallet address or to a specific contract.
", + "smithy.api#http": { + "uri": "/list-transactions", + "method": "POST" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "transactions", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } }, - { - "target": "com.amazonaws.managedblockchainquery#GetAssetContract" + "com.amazonaws.managedblockchainquery#ListTransactionsInput": { + "type": "structure", + "members": { + "address": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The address (either a contract or wallet), whose transactions are being requested.
", + "smithy.api#required": {} + } + }, + "network": { + "target": "com.amazonaws.managedblockchainquery#QueryNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network where the transactions occurred.
", + "smithy.api#required": {} + } + }, + "fromBlockchainInstant": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" + }, + "toBlockchainInstant": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant" + }, + "sort": { + "target": "com.amazonaws.managedblockchainquery#ListTransactionsSort", + "traits": { + "smithy.api#documentation": "Sorts items in an ascending order if the first page starts at fromTime. \n Sorts items in a descending order if the first page starts at toTime.
The pagination token that indicates the next set of results to retrieve.
" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of transactions to list.
\nEven if additional results can be retrieved, the request can return less \n results than maxResults or an empty array of results.
To retrieve the next set of results, make another request with the \n returned nextToken value. The value of nextToken is \n null when there are no more results to return
The array of transactions returned by the request.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.managedblockchainquery#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token that indicates the next set of results to retrieve.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.managedblockchainquery#GetTransaction" + "com.amazonaws.managedblockchainquery#ListTransactionsSort": { + "type": "structure", + "members": { + "sortBy": { + "target": "com.amazonaws.managedblockchainquery#ListTransactionsSortBy", + "traits": { + "smithy.api#documentation": "Defaults to the value TRANSACTION_TIMESTAMP.
The container for the sort order for ListTransactions. \n The SortOrder field only accepts the values ASCENDING \n and DESCENDING. Not providing SortOrder will default \n to ASCENDING.
The container for determining how the list transaction result will \n be sorted.
" + } }, - { - "target": "com.amazonaws.managedblockchainquery#ListAssetContracts" + "com.amazonaws.managedblockchainquery#ListTransactionsSortBy": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TRANSACTION_TIMESTAMP", + "name": "TRANSACTION_TIMESTAMP", + "documentation": "Timestamp of a transaction" + } + ] + } }, - { - "target": "com.amazonaws.managedblockchainquery#ListTokenBalances" + "com.amazonaws.managedblockchainquery#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 131070 + } + } }, - { - "target": "com.amazonaws.managedblockchainquery#ListTransactionEvents" + "com.amazonaws.managedblockchainquery#OwnerFilter": { + "type": "structure", + "members": { + "address": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The contract or wallet address.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The container for the owner information to filter by.
" + } }, - { - "target": "com.amazonaws.managedblockchainquery#ListTransactions" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "ManagedBlockchain Query", - "arnNamespace": "managedblockchain-query" - }, - "aws.auth#sigv4": { - "name": "managedblockchain-query" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "Authorization", - "Date", - "X-Amz-Date", - "X-Amz-Security-Token", - "X-Amz-Target", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": [ - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-errormessage", - "x-amzn-trace-id", - "x-amz-apigw-id", - "date" - ], - "maxAge": 86400 - }, - "smithy.api#documentation": "Amazon Managed Blockchain (AMB) Query provides you with convenient access to multi-blockchain network data, which makes \n it easier for you to extract contextual data related to blockchain activity. You can use AMB Query to \n read data from public blockchain networks, such as Bitcoin Mainnet and Ethereum Mainnet. You can \n also get information such as the current and historical balances of addresses, or you can get a \n list of blockchain transactions for a given time period. Additionally, you can get details of a \n given transaction, such as transaction events, which you can further analyze or use in business \n logic for your applications.
", - "smithy.api#title": "Amazon Managed Blockchain Query", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" + "com.amazonaws.managedblockchainquery#OwnerIdentifier": { + "type": "structure", + "members": { + "address": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The contract or wallet address for the owner.
", + "smithy.api#required": {} + } + } }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" + "traits": { + "smithy.api#documentation": "The container for the identifier of the owner.
" + } + }, + "com.amazonaws.managedblockchainquery#QueryNetwork": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ETHEREUM_MAINNET", + "name": "ETHEREUM_MAINNET", + "documentation": "Ethereum main network" + }, + { + "value": "ETHEREUM_SEPOLIA_TESTNET", + "name": "ETHEREUM_SEPOLIA_TESTNET", + "documentation": "SEPOLIA network (ethereum testnet)" + }, + { + "value": "BITCOIN_MAINNET", + "name": "BITCOIN_MAINNET", + "documentation": "Bitcoin main network" + }, + { + "value": "BITCOIN_TESTNET", + "name": "BITCOIN_TESTNET", + "documentation": "Bitcoin test network" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#QueryTokenId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9]{1,66}$" + } + }, + "com.amazonaws.managedblockchainquery#QueryTokenStandard": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ERC20", + "name": "ERC20" + }, + { + "value": "ERC721", + "name": "ERC721" + }, + { + "value": "ERC1155", + "name": "ERC1155" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#QueryTransactionEventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ERC20_TRANSFER", + "name": "ERC20_TRANSFER", + "documentation": "An ERC20 transfer type" + }, + { + "value": "ERC20_MINT", + "name": "ERC20_MINT", + "documentation": "An ERC20_MINT transfer type" + }, + { + "value": "ERC20_BURN", + "name": "ERC20_BURN", + "documentation": "An ERC20_BURN transfer type" + }, + { + "value": "ERC20_DEPOSIT", + "name": "ERC20_DEPOSIT", + "documentation": "An ERC20_DEPOSIT transfer type" + }, + { + "value": "ERC20_WITHDRAWAL", + "name": "ERC20_WITHDRAWAL", + "documentation": "An ERC20_WITHDRAWAL transfer type" + }, + { + "value": "ERC721_TRANSFER", + "name": "ERC721_TRANSFER", + "documentation": "An ERC721 transfer type" + }, + { + "value": "ERC1155_TRANSFER", + "name": "ERC1155_TRANSFER", + "documentation": "An ERC1155 transfer type" + }, + { + "value": "BITCOIN_VIN", + "name": "BITCOIN_VIN", + "documentation": "A Bitcoin Vin transfer type" + }, + { + "value": "BITCOIN_VOUT", + "name": "BITCOIN_VOUT", + "documentation": "A Bitcoin Vout transfer type" + }, + { + "value": "INTERNAL_ETH_TRANSFER", + "name": "INTERNAL_ETH_TRANSFER", + "documentation": "An internal ETH transfer type" + }, + { + "value": "ETH_TRANSFER", + "name": "ETH_TRANSFER", + "documentation": "An ETH transfer type" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#QueryTransactionHash": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(0x[A-Fa-f0-9]{64}|[A-Fa-f0-9]{64})$" + } + }, + "com.amazonaws.managedblockchainquery#QueryTransactionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FINAL", + "name": "FINAL", + "documentation": "The transaction has been confirmed and is final in the blockchain" + }, + { + "value": "FAILED", + "name": "FAILED", + "documentation": "The transaction completed on the blockchain, but failed" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#QuotaCode": { + "type": "string" + }, + "com.amazonaws.managedblockchainquery#ResourceId": { + "type": "string" + }, + "com.amazonaws.managedblockchainquery#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The container for the exception message.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.managedblockchainquery#ResourceId", + "traits": { + "smithy.api#documentation": "The resourceId of the resource that caused the exception.
The resourceType of the resource that caused the exception.
The resource was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.managedblockchainquery#ResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "collection", + "name": "COLLECTION" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#ServiceCode": { + "type": "string" + }, + "com.amazonaws.managedblockchainquery#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The container for the exception message.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.managedblockchainquery#ResourceId", + "traits": { + "smithy.api#documentation": "The resourceId of the resource that caused the exception.
The resourceType of the resource that caused the exception.
The container for the serviceCode.
The container for the quotaCode.
The service quota has been exceeded for this resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.managedblockchainquery#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASCENDING", + "name": "ASCENDING", + "documentation": "Result sorted in ascending order" + }, { - "ref": "Endpoint" + "value": "DESCENDING", + "name": "DESCENDING", + "documentation": "Result sorted in descending order" + } + ] + } + }, + "com.amazonaws.managedblockchainquery#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The container for the exception message.
", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "com.amazonaws.managedblockchainquery#ServiceCode", + "traits": { + "smithy.api#documentation": "The container for the serviceCode.
The container for the quotaCode.
The container of the retryAfterSeconds value.
The request or operation couldn't be performed because a service is throttling \n requests. The most common source of throttling errors is when you create resources \n that exceed your service limit for this resource type. Request a limit increase or \n delete unused resources, if possible.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true } - ], - "rules": [ + } + }, + "com.amazonaws.managedblockchainquery#TietonChainQueryService": { + "type": "service", + "version": "2023-05-04", + "operations": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "target": "com.amazonaws.managedblockchainquery#BatchGetTokenBalance" + }, + { + "target": "com.amazonaws.managedblockchainquery#GetAssetContract" + }, + { + "target": "com.amazonaws.managedblockchainquery#GetTokenBalance" + }, + { + "target": "com.amazonaws.managedblockchainquery#GetTransaction" + }, + { + "target": "com.amazonaws.managedblockchainquery#ListAssetContracts" + }, + { + "target": "com.amazonaws.managedblockchainquery#ListTokenBalances" + }, + { + "target": "com.amazonaws.managedblockchainquery#ListTransactionEvents" + }, + { + "target": "com.amazonaws.managedblockchainquery#ListTransactions" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "ManagedBlockchain Query", + "arnNamespace": "managedblockchain-query" + }, + "aws.auth#sigv4": { + "name": "managedblockchain-query" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "Authorization", + "Date", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amz-apigw-id", + "date" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Amazon Managed Blockchain (AMB) Query provides you with convenient access to multi-blockchain network data, which makes \n it easier for you to extract contextual data related to blockchain activity. You can use AMB Query to \n read data from public blockchain networks, such as Bitcoin Mainnet and Ethereum Mainnet. You can \n also get information such as the current and historical balances of addresses, or you can get a \n list of blockchain transactions for a given time period. Additionally, you can get details of a \n given transaction, such as transaction events, which you can further analyze or use in business \n logic for your applications.
", + "smithy.api#title": "Amazon Managed Blockchain Query", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://managedblockchain-query.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, { - "ref": "UseFIPS" + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.cn-north-1.amazonaws.com.cn" + } }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "assign": "PartitionResult" - } - ], - "rules": [ + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.us-gov-east-1.api.aws" + } }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.us-gov-east-1.amazonaws.com" } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://managedblockchain-query-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.us-iso-east-1.c2s.ic.gov" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.us-iso-east-1.c2s.ic.gov" } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://managedblockchain-query-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query-fips.us-isob-east-1.sc2s.sgov.gov" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://managedblockchain-query.us-isob-east-1.sc2s.sgov.gov" } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://managedblockchain-query.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" } - ], - "type": "tree" }, { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://managedblockchain-query.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" } - ], - "type": "tree" } - ], - "type": "tree" + ], + "version": "1.0" + } + } + }, + "com.amazonaws.managedblockchainquery#TokenBalance": { + "type": "structure", + "members": { + "ownerIdentifier": { + "target": "com.amazonaws.managedblockchainquery#OwnerIdentifier", + "traits": { + "smithy.api#documentation": "The container for the identifier of the owner.
" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query.cn-north-1.api.amazonwebservices.com.cn" + "tokenIdentifier": { + "target": "com.amazonaws.managedblockchainquery#TokenIdentifier", + "traits": { + "smithy.api#documentation": "The identifier for the token, including the unique token ID and its blockchain network.
" + } + }, + "balance": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The container of the token balance.
", + "smithy.api#required": {} + } + }, + "atBlockchainInstant": { + "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", + "traits": { + "smithy.api#documentation": "The time for when the TokenBalance is requested or \n the current time if a time is not provided in the request.
\nThis time will only be recorded up to the second.
\nThe Timestamp of the last transaction at which the balance for the token in the wallet was updated.
The balance of the token.
" + } + }, + "com.amazonaws.managedblockchainquery#TokenBalanceList": { + "type": "list", + "member": { + "target": "com.amazonaws.managedblockchainquery#TokenBalance" }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.us-gov-east-1.api.aws" + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.us-gov-east-1.amazonaws.com" + } + }, + "com.amazonaws.managedblockchainquery#TokenFilter": { + "type": "structure", + "members": { + "network": { + "target": "com.amazonaws.managedblockchainquery#QueryNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network of the token.
", + "smithy.api#required": {} + } + }, + "contractAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "This is the address of the contract.
" + } + }, + "tokenId": { + "target": "com.amazonaws.managedblockchainquery#QueryTokenId", + "traits": { + "smithy.api#documentation": "The unique identifier of the token.
" + } } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query.us-gov-east-1.api.aws" + "traits": { + "smithy.api#documentation": "The container of the token filter like the contract address \n on a given blockchain network or a unique token identifier on a given \n blockchain network.
\nYou must always specify the network property of this \n container when using this operation.
\nThe blockchain network of the token.
", + "smithy.api#required": {} + } + }, + "contractAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "This is the token's contract address.
" + } + }, + "tokenId": { + "target": "com.amazonaws.managedblockchainquery#QueryTokenId", + "traits": { + "smithy.api#documentation": "The unique identifier of the token.
\nYou must specify this container with btc for the native BTC token, and \n eth for the native ETH token. For all other token types you must \n specify the tokenId in the 64 character hexadecimal tokenid format.
The container for the identifier for the token including the unique token ID and its blockchain network.
\nOnly the native tokens BTC,ETH, and the ERC-20, \n ERC-721, and ERC 1155 token standards are supported.
\nThe blockchain network where the transaction occurred.
", + "smithy.api#required": {} + } + }, + "blockHash": { + "target": "com.amazonaws.managedblockchainquery#BlockHash", + "traits": { + "smithy.api#documentation": "The block hash is a unique identifier for a block. It is a fixed-size \n string that is calculated by using the information in the block. The block \n hash is used to verify the integrity of the data in the block.
" + } + }, + "transactionHash": { + "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", + "traits": { + "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", + "smithy.api#required": {} + } + }, + "blockNumber": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The block number in which the transaction is recorded.
" + } + }, + "transactionTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The Timestamp of the transaction.
The index of the transaction within a blockchain.
", + "smithy.api#required": {} + } + }, + "numberOfTransactions": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The number of transactions in the block.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.managedblockchainquery#QueryTransactionStatus", + "traits": { + "smithy.api#deprecated": { + "message": "The status field in the GetTransaction response is deprecated and is replaced with the confirmationStatus and executionStatus fields." + }, + "smithy.api#documentation": "The status of the transaction.
\nThis property is deprecated. You must use the confirmationStatus \n and the executionStatus properties to determine if the status \n of the transaction is FINAL or FAILED.
Transactions with a status of FINAL will now have the confirmationStatus set \n to FINAL and the executionStatus set to SUCCEEDED.
Transactions with a status of FAILED will now have the confirmationStatus set \n to FINAL and the executionStatus set to FAILED.
The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", + "smithy.api#required": {} + } + }, + "from": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The initiator of the transaction. It is either in the form a public key or a \n contract address.
" + } + }, + "contractAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The blockchain address for the contract.
" + } + }, + "gasUsed": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The amount of gas used for the transaction.
" + } + }, + "cumulativeGasUsed": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The amount of gas used up to the specified point in the block.
" + } + }, + "effectiveGasPrice": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The effective gas price.
" + } + }, + "signatureV": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The signature of the transaction. The Z coordinate of a point V.
" + } + }, + "signatureR": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The signature of the transaction. The X coordinate of a point R.
" + } + }, + "signatureS": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The signature of the transaction. The Y coordinate of a point S.
" + } + }, + "transactionFee": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The transaction fee.
" + } + }, + "transactionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
" + } + }, + "confirmationStatus": { + "target": "com.amazonaws.managedblockchainquery#ConfirmationStatus", + "traits": { + "smithy.api#documentation": "Specifies whether the transaction has reached Finality.
" + } + }, + "executionStatus": { + "target": "com.amazonaws.managedblockchainquery#ExecutionStatus", + "traits": { + "smithy.api#documentation": "Identifies whether the transaction has succeeded or failed.
" + } } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.us-iso-east-1.c2s.ic.gov" + "traits": { + "smithy.api#documentation": "There are two possible types of transactions used for this data type:
\nA Bitcoin transaction is a movement of BTC from one address to \n another.
\nAn Ethereum transaction refers to an action initiated by an externally \n owned account, which is an account managed by a human, not a contract. \n For example, if Bob sends Alice 1 ETH, Bob's account must be debited and \n Alice's must be credited. This state-changing action occurs within a transaction.
\nThe blockchain network where the transaction occurred.
", + "smithy.api#required": {} + } + }, + "transactionHash": { + "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", + "traits": { + "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", + "smithy.api#required": {} + } + }, + "eventType": { + "target": "com.amazonaws.managedblockchainquery#QueryTransactionEventType", + "traits": { + "smithy.api#documentation": "The type of transaction event.
", + "smithy.api#required": {} + } + }, + "from": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The wallet address initiating the transaction. It can either be a public key or a contract.
" + } + }, + "to": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The wallet address receiving the transaction. It can either be a public key or a contract.
" + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value that was transacted.
" + } + }, + "contractAddress": { + "target": "com.amazonaws.managedblockchainquery#ChainAddress", + "traits": { + "smithy.api#documentation": "The blockchain address. for the contract
" + } + }, + "tokenId": { + "target": "com.amazonaws.managedblockchainquery#QueryTokenId", + "traits": { + "smithy.api#documentation": "The unique identifier for the token involved in the transaction.
" + } + }, + "transactionId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
" + } + }, + "voutIndex": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The position of the vout in the transaction output list.
" + } } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "The container for the properties of a transaction event.
" + } + }, + "com.amazonaws.managedblockchainquery#TransactionEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.managedblockchainquery#TransactionEvent" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query.us-iso-east-1.c2s.ic.gov" + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "com.amazonaws.managedblockchainquery#TransactionOutputItem": { + "type": "structure", + "members": { + "transactionHash": { + "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", + "traits": { + "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", + "smithy.api#required": {} + } + }, + "network": { + "target": "com.amazonaws.managedblockchainquery#QueryNetwork", + "traits": { + "smithy.api#documentation": "The blockchain network where the transaction occurred.
", + "smithy.api#required": {} + } + }, + "transactionTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the transaction occurred.
", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "The container of the transaction output.
" + } + }, + "com.amazonaws.managedblockchainquery#TransactionOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.managedblockchainquery#TransactionOutputItem" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://managedblockchain-query.us-isob-east-1.sc2s.sgov.gov" + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" + } + }, + "com.amazonaws.managedblockchainquery#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", + "traits": { + "smithy.api#documentation": "The container for the exception message.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.managedblockchainquery#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The container for the reason for the exception
", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.managedblockchainquery#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The container for the fieldList of the exception.
The resource passed is invalid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.managedblockchainquery#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the field that triggered the ValidationException.
The ValidationException message.
The container for the identifier of the owner.
" - } - }, - "tokenIdentifier": { - "target": "com.amazonaws.managedblockchainquery#TokenIdentifier", - "traits": { - "smithy.api#documentation": "The identifier for the token, including the unique token ID and its blockchain network.
" - } - }, - "balance": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The container of the token balance.
", - "smithy.api#required": {} - } - }, - "atBlockchainInstant": { - "target": "com.amazonaws.managedblockchainquery#BlockchainInstant", - "traits": { - "smithy.api#documentation": "The time for when the TokenBalance is requested or \n the current time if a time is not provided in the request.
\nThis time will only be recorded up to the second.
\nThe Timestamp of the last transaction at which the balance for the token in the wallet was updated.
The balance of the token.
" - } - }, - "com.amazonaws.managedblockchainquery#TokenBalanceList": { - "type": "list", - "member": { - "target": "com.amazonaws.managedblockchainquery#TokenBalance" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.managedblockchainquery#TokenFilter": { - "type": "structure", - "members": { - "network": { - "target": "com.amazonaws.managedblockchainquery#QueryNetwork", - "traits": { - "smithy.api#documentation": "The blockchain network of the token.
", - "smithy.api#required": {} - } - }, - "contractAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "This is the address of the contract.
" - } - }, - "tokenId": { - "target": "com.amazonaws.managedblockchainquery#QueryTokenId", - "traits": { - "smithy.api#documentation": "The unique identifier of the token.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The container of the token filter like the contract address \n on a given blockchain network or a unique token identifier on a given \n blockchain network.
\nYou must always specify the network property of this \n container when using this operation.
\nThe blockchain network of the token.
", - "smithy.api#required": {} - } - }, - "contractAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "This is the token's contract address.
" - } - }, - "tokenId": { - "target": "com.amazonaws.managedblockchainquery#QueryTokenId", - "traits": { - "smithy.api#documentation": "The unique identifier of the token.
\nYou must specify this container with btc for the native BTC token, and \n eth for the native ETH token. For all other token types you must \n specify the tokenId in the 64 character hexadecimal tokenid format.
The container for the identifier for the token including the unique token ID and its blockchain network.
\nOnly the native tokens BTC,ETH, and the ERC-20, \n ERC-721, and ERC 1155 token standards are supported.
\nThe blockchain network where the transaction occurred.
", - "smithy.api#required": {} - } - }, - "blockHash": { - "target": "com.amazonaws.managedblockchainquery#BlockHash", - "traits": { - "smithy.api#documentation": "The block hash is a unique identifier for a block. It is a fixed-size \n string that is calculated by using the information in the block. The block \n hash is used to verify the integrity of the data in the block.
" - } - }, - "transactionHash": { - "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", - "traits": { - "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", - "smithy.api#required": {} - } - }, - "blockNumber": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The block number in which the transaction is recorded.
" - } - }, - "transactionTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The Timestamp of the transaction.
The index of the transaction within a blockchain.
", - "smithy.api#required": {} - } - }, - "numberOfTransactions": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "The number of transactions in the block.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.managedblockchainquery#QueryTransactionStatus", - "traits": { - "smithy.api#documentation": "The status of the transaction.
", - "smithy.api#required": {} - } - }, - "to": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", - "smithy.api#required": {} - } - }, - "from": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The initiator of the transaction. It is either in the form a public key or a \n contract address.
" - } - }, - "contractAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The blockchain address for the contract.
" - } - }, - "gasUsed": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The amount of gas used for the transaction.
" - } - }, - "cumulativeGasUsed": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The amount of gas used up to the specified point in the block.
" - } - }, - "effectiveGasPrice": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The effective gas price.
" - } - }, - "signatureV": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The signature of the transaction. The Z coordinate of a point V.
" - } - }, - "signatureR": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The signature of the transaction. The X coordinate of a point R.
" - } - }, - "signatureS": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The signature of the transaction. The Y coordinate of a point S.
" - } - }, - "transactionFee": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The transaction fee.
" - } - }, - "transactionId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
" - } - } - }, - "traits": { - "smithy.api#documentation": "There are two possible types of transactions used for this data type:
\nA Bitcoin transaction is a movement of BTC from one address to \n another.
\nAn Ethereum transaction refers to an action initiated by an externally \n owned account, which is an account managed by a human, not a contract. \n For example, if Bob sends Alice 1 ETH, Bob's account must be debited and \n Alice's must be credited. This state-changing action occurs within a transaction.
\nThe blockchain network where the transaction occurred.
", - "smithy.api#required": {} - } - }, - "transactionHash": { - "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", - "traits": { - "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", - "smithy.api#required": {} - } - }, - "eventType": { - "target": "com.amazonaws.managedblockchainquery#QueryTransactionEventType", - "traits": { - "smithy.api#documentation": "The type of transaction event.
", - "smithy.api#required": {} - } - }, - "from": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The wallet address initiating the transaction. It can either be a public key or a contract.
" - } - }, - "to": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The wallet address receiving the transaction. It can either be a public key or a contract.
" - } - }, - "value": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The value that was transacted.
" - } - }, - "contractAddress": { - "target": "com.amazonaws.managedblockchainquery#ChainAddress", - "traits": { - "smithy.api#documentation": "The blockchain address. for the contract
" - } - }, - "tokenId": { - "target": "com.amazonaws.managedblockchainquery#QueryTokenId", - "traits": { - "smithy.api#documentation": "The unique identifier for the token involved in the transaction.
" - } - }, - "transactionId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The unique identifier of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
" - } - }, - "voutIndex": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The position of the vout in the transaction output list.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The container for the properties of a transaction event.
" - } - }, - "com.amazonaws.managedblockchainquery#TransactionEventList": { - "type": "list", - "member": { - "target": "com.amazonaws.managedblockchainquery#TransactionEvent" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.managedblockchainquery#TransactionOutputItem": { - "type": "structure", - "members": { - "transactionHash": { - "target": "com.amazonaws.managedblockchainquery#QueryTransactionHash", - "traits": { - "smithy.api#documentation": "The hash of the transaction. It is generated whenever a transaction is verified and added to the blockchain.
", - "smithy.api#required": {} - } - }, - "network": { - "target": "com.amazonaws.managedblockchainquery#QueryNetwork", - "traits": { - "smithy.api#documentation": "The blockchain network where the transaction occurred.
", - "smithy.api#required": {} - } - }, - "transactionTimestamp": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the transaction occurred.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The container of the transaction output.
" - } - }, - "com.amazonaws.managedblockchainquery#TransactionOutputList": { - "type": "list", - "member": { - "target": "com.amazonaws.managedblockchainquery#TransactionOutputItem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.managedblockchainquery#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.managedblockchainquery#ExceptionMessage", - "traits": { - "smithy.api#documentation": "The container for the exception message.
", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.managedblockchainquery#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "The container for the reason for the exception
", - "smithy.api#required": {} - } - }, - "fieldList": { - "target": "com.amazonaws.managedblockchainquery#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "The container for the fieldList of the exception.
The resource passed is invalid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.managedblockchainquery#ValidationExceptionField": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The name of the field that triggered the ValidationException.
The ValidationException message.
The resource passed is invalid.
" + } + }, + "com.amazonaws.managedblockchainquery#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.managedblockchainquery#ValidationExceptionField" + } + }, + "com.amazonaws.managedblockchainquery#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unknownOperation", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "cannotParse", + "name": "CANNOT_PARSE" + }, + { + "value": "fieldValidationFailed", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "other", + "name": "OTHER" + } + ] + } } - }, - "traits": { - "smithy.api#documentation": "The resource passed is invalid.
" - } - }, - "com.amazonaws.managedblockchainquery#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.managedblockchainquery#ValidationExceptionField" - } - }, - "com.amazonaws.managedblockchainquery#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "unknownOperation", - "name": "UNKNOWN_OPERATION" - }, - { - "value": "cannotParse", - "name": "CANNOT_PARSE" - }, - { - "value": "fieldValidationFailed", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "other", - "name": "OTHER" - } - ] - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/mediatailor.json b/codegen/sdk-codegen/aws-models/mediatailor.json index 01b8bb0236a1e..95d76c2788b53 100644 --- a/codegen/sdk-codegen/aws-models/mediatailor.json +++ b/codegen/sdk-codegen/aws-models/mediatailor.json @@ -1,6469 +1,6516 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.mediatailor#AccessConfiguration": { - "type": "structure", - "members": { - "AccessType": { - "target": "com.amazonaws.mediatailor#AccessType", - "traits": { - "smithy.api#documentation": "The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
\n S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
\n• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
\n• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
\n\n AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.
Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements:
• You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint.
• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
\n• The caller of the API must have mediapackagev2:GetObject IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.
Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements:
• You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..
• The mediatailor.amazonaws.com service principal must have permissions to read all top-level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AWS Secrets Manager access token configuration parameters.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Access configuration parameters.
" - } - }, - "com.amazonaws.mediatailor#AccessType": { - "type": "enum", - "members": { - "S3_SIGV4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_SIGV4" - } - }, - "SECRETS_MANAGER_ACCESS_TOKEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECRETS_MANAGER_ACCESS_TOKEN" - } - }, - "AUTODETECT_SIGV4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTODETECT_SIGV4" - } - } - } - }, - "com.amazonaws.mediatailor#AdBreak": { - "type": "structure", - "members": { - "MessageType": { - "target": "com.amazonaws.mediatailor#MessageType", - "traits": { - "smithy.api#documentation": "The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
" - } - }, - "Slate": { - "target": "com.amazonaws.mediatailor#SlateSource", - "traits": { - "smithy.api#documentation": "Ad break slate configuration.
" - } - }, - "SpliceInsertMessage": { - "target": "com.amazonaws.mediatailor#SpliceInsertMessage", - "traits": { - "smithy.api#documentation": "This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
" - } - }, - "AdBreakMetadata": { - "target": "com.amazonaws.mediatailor#AdBreakMetadataList", - "traits": { - "smithy.api#documentation": "Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
Ad break configuration parameters.
" - } - }, - "com.amazonaws.mediatailor#AdBreakMetadataList": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#KeyValuePair" - } - }, - "com.amazonaws.mediatailor#AdBreakOpportunities": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#AdBreakOpportunity" - }, - "traits": { - "smithy.api#documentation": "The list of ad break opportunities detected within the VOD source.
" - } - }, - "com.amazonaws.mediatailor#AdBreakOpportunity": { - "type": "structure", - "members": { - "OffsetMillis": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The offset in milliseconds from the start of the VOD source at which an ad marker was detected.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A location at which a zero-duration ad marker was detected in a VOD source manifest.
" - } - }, - "com.amazonaws.mediatailor#AdMarkerPassthrough": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.mediatailor#__boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Enables ad marker passthrough for your configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
The code for the alert. For example, NOT_PROCESSED.
If an alert is generated for a resource, an explanation of the reason for the alert.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp when the alert was last modified.
", - "smithy.api#required": {} - } - }, - "RelatedResourceArns": { - "target": "com.amazonaws.mediatailor#__listOf__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) related to this alert.
", - "smithy.api#required": {} - } - }, - "ResourceArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "Category": { - "target": "com.amazonaws.mediatailor#AlertCategory", - "traits": { - "smithy.api#documentation": "The category that MediaTailor assigns to the alert.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Alert configuration parameters.
" - } - }, - "com.amazonaws.mediatailor#AlertCategory": { - "type": "enum", - "members": { - "SCHEDULING_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULING_ERROR" - } - }, - "PLAYBACK_WARNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLAYBACK_WARNING" - } - }, - "INFO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INFO" - } - } - } - }, - "com.amazonaws.mediatailor#AvailMatchingCriteria": { - "type": "structure", - "members": { - "DynamicVariable": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
\nYou can include up to 100 dynamic variables.
", - "smithy.api#required": {} - } - }, - "Operator": { - "target": "com.amazonaws.mediatailor#Operator", - "traits": { - "smithy.api#documentation": "For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
\nAs an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.
A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.
" - } - }, - "FillPolicy": { - "target": "com.amazonaws.mediatailor#FillPolicy", - "traits": { - "smithy.api#documentation": "Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" - } - }, - "com.amazonaws.mediatailor#BadRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "traits": { - "smithy.api#documentation": "A request contains unexpected data.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.mediatailor#Bumper": { - "type": "structure", - "members": { - "EndUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for the end bumper asset.
" - } - }, - "StartUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for the start bumper asset.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" - } - }, - "com.amazonaws.mediatailor#CdnConfiguration": { - "type": "structure", - "members": { - "AdSegmentUrlPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" - } - }, - "com.amazonaws.mediatailor#Channel": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the channel.
", - "smithy.api#required": {} - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#required": {} - } - }, - "ChannelState": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Returns the state whether the channel is running or not.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp of when the channel was created.
" - } - }, - "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The timestamp of when the channel was last modified.
" - } - }, - "Outputs": { - "target": "com.amazonaws.mediatailor#ResponseOutputs", - "traits": { - "smithy.api#documentation": "The channel's output properties.
", - "smithy.api#required": {} - } - }, - "PlaybackMode": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The type of playback mode for this channel.
\n\n LINEAR - Programs play back-to-back only once.
\n LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "Tier": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The tier for this channel. STANDARD tier channels can contain live programs.
", - "smithy.api#required": {} - } - }, - "LogConfiguration": { - "target": "com.amazonaws.mediatailor#LogConfigurationForChannel", - "traits": { - "smithy.api#documentation": "The log configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.mediatailor#ChannelResource" - } - ] - } - }, - "com.amazonaws.mediatailor#ChannelPolicy": { - "type": "resource", - "identifiers": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#PutChannelPolicy" - }, - "read": { - "target": "com.amazonaws.mediatailor#GetChannelPolicy" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeleteChannelPolicy" - }, - "traits": { - "aws.api#arn": { - "template": "channel/{ChannelName}" - }, - "aws.cloudformation#cfnResource": { - "name": "ChannelPolicy" - }, - "smithy.api#unstable": {} - } - }, - "com.amazonaws.mediatailor#ChannelResource": { - "type": "resource", - "identifiers": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#CreateChannel" - }, - "read": { - "target": "com.amazonaws.mediatailor#DescribeChannel" - }, - "update": { - "target": "com.amazonaws.mediatailor#UpdateChannel" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeleteChannel" - }, - "list": { - "target": "com.amazonaws.mediatailor#ListChannels" - }, - "operations": [ - { - "target": "com.amazonaws.mediatailor#ConfigureLogsForChannel" - }, - { - "target": "com.amazonaws.mediatailor#CreateChannel" - }, - { - "target": "com.amazonaws.mediatailor#GetChannelSchedule" - }, - { - "target": "com.amazonaws.mediatailor#StartChannel" - }, - { - "target": "com.amazonaws.mediatailor#StopChannel" - } - ], - "resources": [ - { - "target": "com.amazonaws.mediatailor#ChannelPolicy" + "smithy": "2.0", + "shapes": { + "com.amazonaws.mediatailor#AccessConfiguration": { + "type": "structure", + "members": { + "AccessType": { + "target": "com.amazonaws.mediatailor#AccessType", + "traits": { + "smithy.api#documentation": "The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
\n S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
\n• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
\n• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
\n\n AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.
Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements:
• You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint.
• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
\n• The caller of the API must have mediapackagev2:GetObject IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.
Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements:
• You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..
• The mediatailor.amazonaws.com service principal must have permissions to read all top-level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
AWS Secrets Manager access token configuration parameters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Access configuration parameters.
" + } }, - { - "target": "com.amazonaws.mediatailor#ProgramResource" - } - ], - "traits": { - "aws.api#arn": { - "template": "channel/{ChannelName}" - }, - "aws.cloudformation#cfnResource": { - "name": "Channel" - }, - "smithy.api#noReplace": {}, - "smithy.api#unstable": {} - } - }, - "com.amazonaws.mediatailor#ChannelState": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.mediatailor#ClipRange": { - "type": "structure", - "members": { - "EndOffsetMillis": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#documentation": "The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Clip range configuration for the VOD source associated with the program.
" - } - }, - "com.amazonaws.mediatailor#ConfigurationAliasesRequest": { - "type": "map", - "key": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The dynamic variable that has aliases.
" - } - }, - "value": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "Map of aliases to the value to be used at request time.
" - } - }, - "traits": { - "smithy.api#documentation": "The predefined aliases for dynamic variables.
" - } - }, - "com.amazonaws.mediatailor#ConfigurationAliasesResponse": { - "type": "map", - "key": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The dynamic variable that has aliases.
" - } - }, - "value": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "Map of aliases to the value to be used at request time.
" - } - }, - "traits": { - "smithy.api#documentation": "The predefined aliases for dynamic variables.
" - } - }, - "com.amazonaws.mediatailor#ConfigureLogsForChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ConfigureLogsForChannelRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ConfigureLogsForChannelResponse" - }, - "traits": { - "smithy.api#documentation": "Configures Amazon CloudWatch log settings for a channel.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/configureLogs/channel", - "code": 200 - } - } - }, - "com.amazonaws.mediatailor#ConfigureLogsForChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#required": {} - } - }, - "LogTypes": { - "target": "com.amazonaws.mediatailor#LogTypes", - "traits": { - "smithy.api#documentation": "The types of logs to collect.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#ConfigureLogsForChannelResponse": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
" - } - }, - "LogTypes": { - "target": "com.amazonaws.mediatailor#LogTypes", - "traits": { - "smithy.api#documentation": "The types of logs collected.
" - } - } - } - }, - "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationResponse" - }, - "traits": { - "smithy.api#documentation": "Amazon CloudWatch log settings for a playback configuration.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/configureLogs/playbackConfiguration", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationRequest": { - "type": "structure", - "members": { - "PercentEnabled": { - "target": "com.amazonaws.mediatailor#__integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100\n
The name of the playback configuration.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Configures Amazon CloudWatch log settings for a playback configuration.
" - } - }, - "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationResponse": { - "type": "structure", - "members": { - "PercentEnabled": { - "target": "com.amazonaws.mediatailor#__integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.
", - "smithy.api#required": {} - } - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the playback configuration.
" - } - } - } - }, - "com.amazonaws.mediatailor#CreateChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#CreateChannelRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#CreateChannelResponse" - }, - "traits": { - "smithy.api#documentation": "Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/channel/{ChannelName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#CreateChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#httpLabel": {}, - "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The channel's output properties.
", - "smithy.api#required": {} - } - }, - "PlaybackMode": { - "target": "com.amazonaws.mediatailor#PlaybackMode", - "traits": { - "smithy.api#documentation": "The type of playback mode to use for this channel.
\n\n LINEAR - The programs in the schedule play once back-to-back in the schedule.
\n LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "Tier": { - "target": "com.amazonaws.mediatailor#Tier", - "traits": { - "smithy.api#documentation": "The tier of the channel.
" - } - } - } - }, - "com.amazonaws.mediatailor#CreateChannelResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) to assign to the channel.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the channel.
" - } - }, - "ChannelState": { - "target": "com.amazonaws.mediatailor#ChannelState", - "traits": { - "smithy.api#documentation": "Indicates whether the channel is in a running state or not.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp of when the channel was created.
" - } - }, - "FillerSlate": { - "target": "com.amazonaws.mediatailor#SlateSource", - "traits": { - "smithy.api#documentation": "Contains information about the slate used to fill gaps between programs in the schedule.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp of when the channel was last modified.
" - } - }, - "Outputs": { - "target": "com.amazonaws.mediatailor#ResponseOutputs", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The output properties to assign to the channel.
", - "smithy.api#unstable": {} - } - }, - "PlaybackMode": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The playback mode to assign to the channel.
", - "smithy.api#unstable": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "Tier": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The tier of the channel.
", - "smithy.api#unstable": {} - } - } - } - }, - "com.amazonaws.mediatailor#CreateLiveSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#CreateLiveSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#CreateLiveSourceResponse" - }, - "traits": { - "smithy.api#documentation": "The live source configuration.
", - "smithy.api#http": { - "method": "POST", - "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#CreateLiveSourceRequest": { - "type": "structure", - "members": { - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configuration parameters for this live source.
", - "smithy.api#required": {} - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the live source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#CreateLiveSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN to assign to the live source.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the live source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configuration parameters for this live source.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the live source was last modified.
" - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the live source.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the source location of the live source.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#CreatePrefetchSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleResponse" - }, - "traits": { - "smithy.api#documentation": "Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest": { - "type": "structure", - "members": { - "Consumption": { - "target": "com.amazonaws.mediatailor#PrefetchConsumption", - "traits": { - "smithy.api#documentation": "The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the schedule request.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the playback configuration.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Retrieval": { - "target": "com.amazonaws.mediatailor#PrefetchRetrieval", - "traits": { - "smithy.api#documentation": "The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
", - "smithy.api#required": {} - } - }, - "StreamId": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
The ARN to assign to the prefetch schedule.
" - } - }, - "Consumption": { - "target": "com.amazonaws.mediatailor#PrefetchConsumption", - "traits": { - "smithy.api#documentation": "The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
" - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the prefetch schedule.
" - } - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the playback configuration.
" - } - }, - "Retrieval": { - "target": "com.amazonaws.mediatailor#PrefetchRetrieval", - "traits": { - "smithy.api#documentation": "The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
" - } - }, - "StreamId": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/channel/{ChannelName}/program/{ProgramName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#CreateProgramRequest": { - "type": "structure", - "members": { - "AdBreaks": { - "target": "com.amazonaws.mediatailor#__listOfAdBreak", - "traits": { - "smithy.api#documentation": "The ad break configuration settings.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel for this Program.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the LiveSource for this Program.
" - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the Program.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ScheduleConfiguration": { - "target": "com.amazonaws.mediatailor#ScheduleConfiguration", - "traits": { - "smithy.api#documentation": "The schedule configuration settings.
", - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#required": {} - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that's used to refer to a VOD source.
" - } - } - } - }, - "com.amazonaws.mediatailor#CreateProgramResponse": { - "type": "structure", - "members": { - "AdBreaks": { - "target": "com.amazonaws.mediatailor#__listOfAdBreak", - "traits": { - "smithy.api#documentation": "The ad break configuration settings.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN to assign to the program.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the channel for this program.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the program was created.
" - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the LiveSource for this Program.
" - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to this program.
" - } - }, - "ScheduledStartTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The scheduled start time for this Program.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the source location for this program.
" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that's used to refer to a VOD source.
" - } - }, - "ClipRange": { - "target": "com.amazonaws.mediatailor#ClipRange", - "traits": { - "smithy.api#documentation": "The clip range configuration settings.
" - } - }, - "DurationMillis": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#documentation": "The duration of the live program in milliseconds.
" - } - } - } - }, - "com.amazonaws.mediatailor#CreateSourceLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#CreateSourceLocationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#CreateSourceLocationResponse" - }, - "traits": { - "smithy.api#documentation": "Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/sourceLocation/{SourceLocationName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#CreateSourceLocationRequest": { - "type": "structure", - "members": { - "AccessConfiguration": { - "target": "com.amazonaws.mediatailor#AccessConfiguration", - "traits": { - "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" - } - }, - "DefaultSegmentDeliveryConfiguration": { - "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The optional configuration for the server that serves segments.
" - } - }, - "HttpConfiguration": { - "target": "com.amazonaws.mediatailor#HttpConfiguration", - "traits": { - "smithy.api#documentation": "The source's HTTP package configurations.
", - "smithy.api#required": {} - } - }, - "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name associated with the source location.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#CreateSourceLocationResponse": { - "type": "structure", - "members": { - "AccessConfiguration": { - "target": "com.amazonaws.mediatailor#AccessConfiguration", - "traits": { - "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN to assign to the source location.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the source location was created.
" - } - }, - "DefaultSegmentDeliveryConfiguration": { - "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The optional configuration for the server that serves segments.
" - } - }, - "HttpConfiguration": { - "target": "com.amazonaws.mediatailor#HttpConfiguration", - "traits": { - "smithy.api#documentation": "The source's HTTP package configurations.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the source location was last modified.
" - } - }, - "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the source location.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#CreateVodSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#CreateVodSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#CreateVodSourceResponse" - }, - "traits": { - "smithy.api#documentation": "The VOD source configuration parameters.
", - "smithy.api#http": { - "method": "POST", - "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#CreateVodSourceRequest": { - "type": "structure", - "members": { - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configuration parameters for this VOD source.
", - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location for this VOD source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name associated with the VOD source.>
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#CreateVodSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN to assign to this VOD source.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the VOD source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configuration parameters for this VOD source.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the VOD source was last modified.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the source location for this VOD source.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the VOD source.
" - } - } - } - }, - "com.amazonaws.mediatailor#DashConfiguration": { - "type": "structure", - "members": { - "ManifestEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
" - } - }, - "MpdLocation": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
The configuration for DASH content.
" - } - }, - "com.amazonaws.mediatailor#DashConfigurationForPut": { - "type": "structure", - "members": { - "MpdLocation": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
The configuration for DASH PUT operations.
" - } - }, - "com.amazonaws.mediatailor#DashPlaylistSettings": { - "type": "structure", - "members": { - "ManifestWindowSeconds": { - "target": "com.amazonaws.mediatailor#__integer", - "traits": { - "smithy.api#documentation": "The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
Dash manifest configuration parameters.
" - } - }, - "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration": { - "type": "structure", - "members": { - "BaseUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
" - } - }, - "com.amazonaws.mediatailor#DeleteChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeleteChannelRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeleteChannelResponse" - }, - "traits": { - "smithy.api#documentation": "Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/channel/{ChannelName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#DeleteChannelPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeleteChannelPolicyRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeleteChannelPolicyResponse" - }, - "traits": { - "smithy.api#documentation": "The channel policy to delete.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/channel/{ChannelName}/policy", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#DeleteChannelPolicyRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel associated with this channel policy.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeleteChannelPolicyResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DeleteChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeleteChannelResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DeleteLiveSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeleteLiveSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeleteLiveSourceResponse" - }, - "traits": { - "smithy.api#documentation": "The live source to delete.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#DeleteLiveSourceRequest": { - "type": "structure", - "members": { - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the live source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this Live Source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeleteLiveSourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DeletePlaybackConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeletePlaybackConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeletePlaybackConfigurationResponse" - }, - "traits": { - "smithy.api#documentation": "Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/playbackConfiguration/{Name}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#DeletePlaybackConfigurationRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the playback configuration.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeletePlaybackConfigurationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DeletePrefetchSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse" - }, - "traits": { - "smithy.api#documentation": "Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the playback configuration for this prefetch schedule.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DeleteProgram": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeleteProgramRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeleteProgramResponse" - }, - "traits": { - "smithy.api#documentation": "Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/channel/{ChannelName}/program/{ProgramName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#DeleteProgramRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the program.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeleteProgramResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DeleteSourceLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeleteSourceLocationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeleteSourceLocationResponse" - }, - "traits": { - "smithy.api#documentation": "Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/sourceLocation/{SourceLocationName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#DeleteSourceLocationRequest": { - "type": "structure", - "members": { - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeleteSourceLocationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DeleteVodSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DeleteVodSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DeleteVodSourceResponse" - }, - "traits": { - "smithy.api#documentation": "The video on demand (VOD) source to delete.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#DeleteVodSourceRequest": { - "type": "structure", - "members": { - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DeleteVodSourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#DescribeChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DescribeChannelRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DescribeChannelResponse" - }, - "traits": { - "smithy.api#documentation": "Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "GET", - "uri": "/channel/{ChannelName}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#DescribeChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DescribeChannelResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the channel.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
" - } - }, - "ChannelState": { - "target": "com.amazonaws.mediatailor#ChannelState", - "traits": { - "smithy.api#documentation": "Indicates whether the channel is in a running state or not.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp of when the channel was created.
" - } - }, - "FillerSlate": { - "target": "com.amazonaws.mediatailor#SlateSource", - "traits": { - "smithy.api#documentation": "Contains information about the slate used to fill gaps between programs in the schedule.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp of when the channel was last modified.
" - } - }, - "Outputs": { - "target": "com.amazonaws.mediatailor#ResponseOutputs", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The channel's output properties.
", - "smithy.api#unstable": {} - } - }, - "PlaybackMode": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The channel's playback mode.
", - "smithy.api#unstable": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "Tier": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The channel's tier.
", - "smithy.api#unstable": {} - } - }, - "LogConfiguration": { - "target": "com.amazonaws.mediatailor#LogConfigurationForChannel", - "traits": { - "smithy.api#documentation": "The log configuration for the channel.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DescribeLiveSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DescribeLiveSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DescribeLiveSourceResponse" - }, - "traits": { - "smithy.api#documentation": "The live source to describe.
", - "smithy.api#http": { - "method": "GET", - "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#DescribeLiveSourceRequest": { - "type": "structure", - "members": { - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the live source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this Live Source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DescribeLiveSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the live source.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "The HTTP package configurations.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the live source was modified.
" - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the live source.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with the live source.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#DescribeProgram": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DescribeProgramRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DescribeProgramResponse" - }, - "traits": { - "smithy.api#documentation": "Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "GET", - "uri": "/channel/{ChannelName}/program/{ProgramName}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#DescribeProgramRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel associated with this Program.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the program.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DescribeProgramResponse": { - "type": "structure", - "members": { - "AdBreaks": { - "target": "com.amazonaws.mediatailor#__listOfAdBreak", - "traits": { - "smithy.api#documentation": "The ad break configuration settings.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the program.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel that the program belongs to.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp of when the program was created.
" - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the LiveSource for this Program.
" - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the program.
" - } - }, - "ScheduledStartTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The source location name.
" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that's used to refer to a VOD source.
" - } - }, - "ClipRange": { - "target": "com.amazonaws.mediatailor#ClipRange", - "traits": { - "smithy.api#documentation": "The clip range configuration settings.
" - } - }, - "DurationMillis": { - "target": "smithy.api#Long", - "traits": { - "smithy.api#documentation": "The duration of the live program in milliseconds.
" - } - } - } - }, - "com.amazonaws.mediatailor#DescribeSourceLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DescribeSourceLocationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DescribeSourceLocationResponse" - }, - "traits": { - "smithy.api#documentation": "Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "GET", - "uri": "/sourceLocation/{SourceLocationName}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#DescribeSourceLocationRequest": { - "type": "structure", - "members": { - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DescribeSourceLocationResponse": { - "type": "structure", - "members": { - "AccessConfiguration": { - "target": "com.amazonaws.mediatailor#AccessConfiguration", - "traits": { - "smithy.api#documentation": "The access configuration for the source location.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the source location.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" - } - }, - "DefaultSegmentDeliveryConfiguration": { - "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The default segment delivery configuration settings.
" - } - }, - "HttpConfiguration": { - "target": "com.amazonaws.mediatailor#HttpConfiguration", - "traits": { - "smithy.api#documentation": "The HTTP package configuration settings for the source location.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" - } - }, - "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#DescribeVodSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#DescribeVodSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#DescribeVodSourceResponse" - }, - "traits": { - "smithy.api#documentation": "Provides details about a specific video on demand (VOD) source in a specific source location.
", - "smithy.api#http": { - "method": "GET", - "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#DescribeVodSourceRequest": { - "type": "structure", - "members": { - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD Source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#DescribeVodSourceResponse": { - "type": "structure", - "members": { - "AdBreakOpportunities": { - "target": "com.amazonaws.mediatailor#AdBreakOpportunities", - "traits": { - "smithy.api#documentation": "The ad break opportunities within the VOD source.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the VOD source.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "The HTTP package configurations.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The last modified time of the VOD source.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with the VOD source.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD source.
" - } - } - } - }, - "com.amazonaws.mediatailor#FillPolicy": { - "type": "enum", - "members": { - "FULL_AVAIL_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL_AVAIL_ONLY" - } - }, - "PARTIAL_AVAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTIAL_AVAIL" - } - } - } - }, - "com.amazonaws.mediatailor#GetChannelPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#GetChannelPolicyRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#GetChannelPolicyResponse" - }, - "traits": { - "smithy.api#documentation": "Returns the channel's IAM policy. IAM policies are used to control access to your channel.
", - "smithy.api#http": { - "method": "GET", - "uri": "/channel/{ChannelName}/policy", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#GetChannelPolicyRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel associated with this Channel Policy.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#GetChannelPolicyResponse": { - "type": "structure", - "members": { - "Policy": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The IAM policy for the channel. IAM policies are used to control access to your channel.
" - } - } - } - }, - "com.amazonaws.mediatailor#GetChannelSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#GetChannelScheduleRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#GetChannelScheduleResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves information about your channel's schedule.
", - "smithy.api#http": { - "method": "GET", - "uri": "/channel/{ChannelName}/schedule", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#GetChannelScheduleRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel associated with this Channel Schedule.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DurationMinutes": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The duration in minutes of the channel schedule.
", - "smithy.api#httpQuery": "durationMinutes" - } - }, - "MaxResults": { - "target": "com.amazonaws.mediatailor#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.
(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more channel schedules to get.
A list of schedule entries for the channel.
" - } - }, - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#GetPlaybackConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#GetPlaybackConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#GetPlaybackConfigurationResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", - "smithy.api#http": { - "method": "GET", - "uri": "/playbackConfiguration/{Name}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#GetPlaybackConfigurationRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The identifier for the playback configuration.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#GetPlaybackConfigurationResponse": { - "type": "structure", - "members": { - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
" - } - }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", - "traits": { - "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" - } - }, - "Bumper": { - "target": "com.amazonaws.mediatailor#Bumper", - "traits": { - "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" - } - }, - "CdnConfiguration": { - "target": "com.amazonaws.mediatailor#CdnConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" - } - }, - "ConfigurationAliases": { - "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", - "traits": { - "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" - } - }, - "DashConfiguration": { - "target": "com.amazonaws.mediatailor#DashConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for DASH content.
" - } - }, - "HlsConfiguration": { - "target": "com.amazonaws.mediatailor#HlsConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for HLS content.
" - } - }, - "LivePreRollConfiguration": { - "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" - } - }, - "LogConfiguration": { - "target": "com.amazonaws.mediatailor#LogConfiguration", - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch log settings for a playback configuration.
" - } - }, - "ManifestProcessingRules": { - "target": "com.amazonaws.mediatailor#ManifestProcessingRules", - "traits": { - "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The identifier for the playback configuration.
" - } - }, - "PersonalizationThresholdSeconds": { - "target": "com.amazonaws.mediatailor#__integerMin1", - "traits": { - "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" - } - }, - "PlaybackConfigurationArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the playback configuration.
" - } - }, - "PlaybackEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
" - } - }, - "SessionInitializationEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL that the player uses to initialize a session that uses client-side reporting.
" - } - }, - "SlateAdUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "TranscodeProfileName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" - } - }, - "VideoContentSourceUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" - } - } - } - }, - "com.amazonaws.mediatailor#GetPrefetchSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#GetPrefetchScheduleRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#GetPrefetchScheduleResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "GET", - "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#GetPrefetchScheduleRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
The Amazon Resource Name (ARN) of the prefetch schedule.
" - } - }, - "Consumption": { - "target": "com.amazonaws.mediatailor#PrefetchConsumption", - "traits": { - "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
" - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
" - } - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
" - } - }, - "Retrieval": { - "target": "com.amazonaws.mediatailor#PrefetchRetrieval", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
" - } - }, - "StreamId": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" - } - } - } - }, - "com.amazonaws.mediatailor#HlsConfiguration": { - "type": "structure", - "members": { - "ManifestEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for HLS content.
" - } - }, - "com.amazonaws.mediatailor#HlsPlaylistSettings": { - "type": "structure", - "members": { - "ManifestWindowSeconds": { - "target": "com.amazonaws.mediatailor#__integer", - "traits": { - "smithy.api#documentation": "The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
HLS playlist configuration parameters.
" - } - }, - "com.amazonaws.mediatailor#HttpConfiguration": { - "type": "structure", - "members": { - "BaseUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The base URL for the source location host server. This string must include the protocol, such as https://.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The HTTP configuration for the source location.
" - } - }, - "com.amazonaws.mediatailor#HttpPackageConfiguration": { - "type": "structure", - "members": { - "Path": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
The streaming protocol for this package configuration. Supported values are HLS and DASH.
The HTTP package configuration properties for the requested VOD source.
" - } - }, - "com.amazonaws.mediatailor#HttpPackageConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#HttpPackageConfiguration" - }, - "traits": { - "smithy.api#documentation": "The VOD source's HTTP package configuration settings.
" - } - }, - "com.amazonaws.mediatailor#KeyValuePair": { - "type": "structure", - "members": { - "Key": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a key, you must also specify a corresponding value.
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a value, you must also specify a corresponding key.
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the EXT-X-ASSETtag.
Lists the alerts that are associated with a MediaTailor channel assembly resource.
", - "smithy.api#http": { - "method": "GET", - "uri": "/alerts", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#ListAlertsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.mediatailor#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "ResourceArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#httpQuery": "resourceArn", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#ListAlertsResponse": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.mediatailor#__listOfAlert", - "traits": { - "smithy.api#documentation": "A list of alerts that are associated with this resource.
" - } - }, - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#ListChannels": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ListChannelsRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ListChannelsResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves information about the channels that are associated with the current AWS account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/channels", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#ListChannelsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.mediatailor#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.mediatailor#ListChannelsResponse": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.mediatailor#__listOfChannel", - "traits": { - "smithy.api#documentation": "A list of channels that are associated with this account.
" - } - }, - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#ListLiveSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ListLiveSourcesRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ListLiveSourcesResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the live sources contained in a source location. A source represents a piece of content.
", - "smithy.api#http": { - "method": "GET", - "uri": "/sourceLocation/{SourceLocationName}/liveSources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#ListLiveSourcesRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.mediatailor#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this Live Sources list.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#ListLiveSourcesResponse": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.mediatailor#__listOfLiveSource", - "traits": { - "smithy.api#documentation": "Lists the live sources.
" - } - }, - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#ListPlaybackConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ListPlaybackConfigurationsRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ListPlaybackConfigurationsResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
", - "smithy.api#http": { - "method": "GET", - "uri": "/playbackConfigurations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#ListPlaybackConfigurationsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.mediatailor#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", - "smithy.api#httpQuery": "NextToken" - } - } - } - }, - "com.amazonaws.mediatailor#ListPlaybackConfigurationsResponse": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.mediatailor#__listOfPlaybackConfiguration", - "traits": { - "smithy.api#documentation": "Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.
" - } - }, - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#ListPrefetchSchedules": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the prefetch schedules for a playback configuration.
", - "smithy.api#http": { - "method": "POST", - "uri": "/prefetchSchedule/{PlaybackConfigurationName}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {}, - "smithy.api#suppress": ["HttpMethodSemantics"] - } - }, - "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.mediatailor#__integerMin1Max100", - "traits": { - "smithy.api#documentation": "The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.
(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.
For the first ListPrefetchSchedulesRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
Retrieves the prefetch schedule(s) for a specific playback configuration.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "StreamId": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
" - } - } - } - }, - "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.mediatailor#__listOfPrefetchSchedule", - "traits": { - "smithy.api#documentation": "Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#ListSourceLocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ListSourceLocationsRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ListSourceLocationsResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.
", - "smithy.api#http": { - "method": "GET", - "uri": "/sourceLocations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#ListSourceLocationsRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.mediatailor#MaxResults", - "traits": { - "smithy.api#documentation": " The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - } - } - }, - "com.amazonaws.mediatailor#ListSourceLocationsResponse": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.mediatailor#__listOfSourceLocation", - "traits": { - "smithy.api#documentation": "A list of source locations.
" - } - }, - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.mediatailor#BadRequestException" - } - ], - "traits": { - "smithy.api#documentation": "A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{ResourceArn}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with this resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#ListVodSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#ListVodSourcesRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#ListVodSourcesResponse" - }, - "traits": { - "smithy.api#documentation": "Lists the VOD sources contained in a source location. A source represents a piece of content.
", - "smithy.api#http": { - "method": "GET", - "uri": "/sourceLocation/{SourceLocationName}/vodSources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Items", - "pageSize": "MaxResults" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.mediatailor#ListVodSourcesRequest": { - "type": "structure", - "members": { - "MaxResults": { - "target": "com.amazonaws.mediatailor#MaxResults", - "traits": { - "smithy.api#documentation": " The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", - "smithy.api#httpQuery": "nextToken" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this VOD Source list.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#ListVodSourcesResponse": { - "type": "structure", - "members": { - "Items": { - "target": "com.amazonaws.mediatailor#__listOfVodSource", - "traits": { - "smithy.api#documentation": "Lists the VOD sources.
" - } - }, - "NextToken": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" - } - } - } - }, - "com.amazonaws.mediatailor#LivePreRollConfiguration": { - "type": "structure", - "members": { - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
" - } - }, - "MaxDurationSeconds": { - "target": "com.amazonaws.mediatailor#__integer", - "traits": { - "smithy.api#documentation": "The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" - } - }, - "com.amazonaws.mediatailor#LiveSource": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN for the live source.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "The HTTP package configurations for the live source.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the live source was last modified.
" - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that's used to refer to a live source.
", - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#documentation": "Live source configuration parameters.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.mediatailor#LiveSourceResource" - } - ] - } - }, - "com.amazonaws.mediatailor#LiveSourceResource": { - "type": "resource", - "identifiers": { - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string" - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#CreateLiveSource" - }, - "read": { - "target": "com.amazonaws.mediatailor#DescribeLiveSource" - }, - "update": { - "target": "com.amazonaws.mediatailor#UpdateLiveSource" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeleteLiveSource" - }, - "list": { - "target": "com.amazonaws.mediatailor#ListLiveSources" - }, - "traits": { - "aws.api#arn": { - "template": "liveSource/{SourceLocationName}/{LiveSourceName}" - }, - "aws.cloudformation#cfnResource": { - "name": "LiveSource" - }, - "smithy.api#unstable": {} - } - }, - "com.amazonaws.mediatailor#LogConfiguration": { - "type": "structure", - "members": { - "PercentEnabled": { - "target": "com.amazonaws.mediatailor#__integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100\n
Returns Amazon CloudWatch log settings for a playback configuration.
" - } - }, - "com.amazonaws.mediatailor#LogConfigurationForChannel": { - "type": "structure", - "members": { - "LogTypes": { - "target": "com.amazonaws.mediatailor#LogTypes", - "traits": { - "smithy.api#documentation": "The log types.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The log configuration for the channel.
" - } - }, - "com.amazonaws.mediatailor#LogType": { - "type": "enum", - "members": { - "AS_RUN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AS_RUN" - } - } - } - }, - "com.amazonaws.mediatailor#LogTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#LogType" - } - }, - "com.amazonaws.mediatailor#ManifestProcessingRules": { - "type": "structure", - "members": { - "AdMarkerPassthrough": { - "target": "com.amazonaws.mediatailor#AdMarkerPassthrough", - "traits": { - "smithy.api#documentation": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" - } - }, - "com.amazonaws.mediatailor#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.mediatailor#MediaTailor": { - "type": "service", - "version": "2018-04-23", - "operations": [ - { - "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfiguration" - }, - { - "target": "com.amazonaws.mediatailor#ListAlerts" - }, - { - "target": "com.amazonaws.mediatailor#ListTagsForResource" - }, - { - "target": "com.amazonaws.mediatailor#TagResource" - }, - { - "target": "com.amazonaws.mediatailor#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.mediatailor#ChannelResource" + "com.amazonaws.mediatailor#AccessType": { + "type": "enum", + "members": { + "S3_SIGV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_SIGV4" + } + }, + "SECRETS_MANAGER_ACCESS_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECRETS_MANAGER_ACCESS_TOKEN" + } + }, + "AUTODETECT_SIGV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTODETECT_SIGV4" + } + } + } + }, + "com.amazonaws.mediatailor#AdBreak": { + "type": "structure", + "members": { + "MessageType": { + "target": "com.amazonaws.mediatailor#MessageType", + "traits": { + "smithy.api#documentation": "The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
" + } + }, + "Slate": { + "target": "com.amazonaws.mediatailor#SlateSource", + "traits": { + "smithy.api#documentation": "Ad break slate configuration.
" + } + }, + "SpliceInsertMessage": { + "target": "com.amazonaws.mediatailor#SpliceInsertMessage", + "traits": { + "smithy.api#documentation": "This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
" + } + }, + "AdBreakMetadata": { + "target": "com.amazonaws.mediatailor#AdBreakMetadataList", + "traits": { + "smithy.api#documentation": "Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
Ad break configuration parameters.
" + } }, - { - "target": "com.amazonaws.mediatailor#LiveSourceResource" + "com.amazonaws.mediatailor#AdBreakMetadataList": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#KeyValuePair" + } }, - { - "target": "com.amazonaws.mediatailor#PlaybackConfigurationResource" + "com.amazonaws.mediatailor#AdBreakOpportunities": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AdBreakOpportunity" + }, + "traits": { + "smithy.api#documentation": "The list of ad break opportunities detected within the VOD source.
" + } }, - { - "target": "com.amazonaws.mediatailor#PrefetchScheduleResource" + "com.amazonaws.mediatailor#AdBreakOpportunity": { + "type": "structure", + "members": { + "OffsetMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The offset in milliseconds from the start of the VOD source at which an ad marker was detected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A location at which a zero-duration ad marker was detected in a VOD source manifest.
" + } }, - { - "target": "com.amazonaws.mediatailor#SourceLocationResource" + "com.amazonaws.mediatailor#AdMarkerPassthrough": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.mediatailor#__boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Enables ad marker passthrough for your configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
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.
\nThrough 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", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" + "com.amazonaws.mediatailor#AdMarkupType": { + "type": "enum", + "members": { + "DATERANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATERANGE" + } + }, + "SCTE35_ENHANCED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCTE35_ENHANCED" } - ] } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + } + }, + "com.amazonaws.mediatailor#Alert": { + "type": "structure", + "members": { + "AlertCode": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The code for the alert. For example, NOT_PROCESSED.
If an alert is generated for a resource, an explanation of the reason for the alert.
", + "smithy.api#required": {} } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp when the alert was last modified.
", + "smithy.api#required": {} + } + }, + "RelatedResourceArns": { + "target": "com.amazonaws.mediatailor#__listOf__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) related to this alert.
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + }, + "Category": { + "target": "com.amazonaws.mediatailor#AlertCategory", + "traits": { + "smithy.api#documentation": "The category that MediaTailor assigns to the alert.
" + } } - ], - "type": "tree" }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" + "traits": { + "smithy.api#documentation": "Alert configuration parameters.
" + } + }, + "com.amazonaws.mediatailor#AlertCategory": { + "type": "enum", + "members": { + "SCHEDULING_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULING_ERROR" + } + }, + "PLAYBACK_WARNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLAYBACK_WARNING" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INFO" } - ] } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + } + }, + "com.amazonaws.mediatailor#AvailMatchingCriteria": { + "type": "structure", + "members": { + "DynamicVariable": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
\nYou can include up to 100 dynamic variables.
", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.mediatailor#Operator", + "traits": { + "smithy.api#documentation": "For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
\nAs an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.
A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.
" + } + }, + "FillPolicy": { + "target": "com.amazonaws.mediatailor#FillPolicy", + "traits": { + "smithy.api#documentation": "Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" + } + }, + "com.amazonaws.mediatailor#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "traits": { + "smithy.api#documentation": "A request contains unexpected data.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.mediatailor#Bumper": { + "type": "structure", + "members": { + "EndUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for the end bumper asset.
" + } + }, + "StartUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for the start bumper asset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" + } + }, + "com.amazonaws.mediatailor#CdnConfiguration": { + "type": "structure", + "members": { + "AdSegmentUrlPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" + } + }, + "com.amazonaws.mediatailor#Channel": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the channel.
", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#required": {} + } + }, + "ChannelState": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Returns the state whether the channel is running or not.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp of when the channel was created.
" + } + }, + "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The timestamp of when the channel was last modified.
" } - ], - "rules": [ + }, + "Outputs": { + "target": "com.amazonaws.mediatailor#ResponseOutputs", + "traits": { + "smithy.api#documentation": "The channel's output properties.
", + "smithy.api#required": {} + } + }, + "PlaybackMode": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The type of playback mode for this channel.
\n\n LINEAR - Programs play back-to-back only once.
\n LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The tier for this channel. STANDARD tier channels can contain live programs.
", + "smithy.api#required": {} + } + }, + "LogConfiguration": { + "target": "com.amazonaws.mediatailor#LogConfigurationForChannel", + "traits": { + "smithy.api#documentation": "The log configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", + "smithy.api#references": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, + "resource": "com.amazonaws.mediatailor#ChannelResource" + } + ] + } + }, + "com.amazonaws.mediatailor#ChannelPolicy": { + "type": "resource", + "identifiers": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#PutChannelPolicy" + }, + "read": { + "target": "com.amazonaws.mediatailor#GetChannelPolicy" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeleteChannelPolicy" + }, + "traits": { + "aws.api#arn": { + "template": "channel/{ChannelName}" + }, + "aws.cloudformation#cfnResource": { + "name": "ChannelPolicy" + }, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.mediatailor#ChannelResource": { + "type": "resource", + "identifiers": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#CreateChannel" + }, + "read": { + "target": "com.amazonaws.mediatailor#DescribeChannel" + }, + "update": { + "target": "com.amazonaws.mediatailor#UpdateChannel" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeleteChannel" + }, + "list": { + "target": "com.amazonaws.mediatailor#ListChannels" + }, + "operations": [ + { + "target": "com.amazonaws.mediatailor#ConfigureLogsForChannel" + }, + { + "target": "com.amazonaws.mediatailor#CreateChannel" + }, + { + "target": "com.amazonaws.mediatailor#GetChannelSchedule" + }, + { + "target": "com.amazonaws.mediatailor#StartChannel" + }, + { + "target": "com.amazonaws.mediatailor#StopChannel" + } + ], + "resources": [ + { + "target": "com.amazonaws.mediatailor#ChannelPolicy" + }, + { + "target": "com.amazonaws.mediatailor#ProgramResource" + } + ], + "traits": { + "aws.api#arn": { + "template": "channel/{ChannelName}" + }, + "aws.cloudformation#cfnResource": { + "name": "Channel" + }, + "smithy.api#noReplace": {}, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.mediatailor#ChannelState": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.mediatailor#ClipRange": { + "type": "structure", + "members": { + "EndOffsetMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Clip range configuration for the VOD source associated with the program.
" + } + }, + "com.amazonaws.mediatailor#ConfigurationAliasesRequest": { + "type": "map", + "key": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The dynamic variable that has aliases.
" + } + }, + "value": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "Map of aliases to the value to be used at request time.
" + } + }, + "traits": { + "smithy.api#documentation": "The predefined aliases for dynamic variables.
" + } + }, + "com.amazonaws.mediatailor#ConfigurationAliasesResponse": { + "type": "map", + "key": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The dynamic variable that has aliases.
" + } + }, + "value": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "Map of aliases to the value to be used at request time.
" + } + }, + "traits": { + "smithy.api#documentation": "The predefined aliases for dynamic variables.
" + } + }, + "com.amazonaws.mediatailor#ConfigureLogsForChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ConfigureLogsForChannelRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ConfigureLogsForChannelResponse" + }, + "traits": { + "smithy.api#documentation": "Configures Amazon CloudWatch log settings for a channel.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/configureLogs/channel", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#ConfigureLogsForChannelRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#required": {} + } + }, + "LogTypes": { + "target": "com.amazonaws.mediatailor#LogTypes", + "traits": { + "smithy.api#documentation": "The types of logs to collect.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#ConfigureLogsForChannelResponse": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
" + } + }, + "LogTypes": { + "target": "com.amazonaws.mediatailor#LogTypes", + "traits": { + "smithy.api#documentation": "The types of logs collected.
" + } + } + } + }, + "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationResponse" + }, + "traits": { + "smithy.api#documentation": "Amazon CloudWatch log settings for a playback configuration.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/configureLogs/playbackConfiguration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationRequest": { + "type": "structure", + "members": { + "PercentEnabled": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100\n
The name of the playback configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configures Amazon CloudWatch log settings for a playback configuration.
" + } + }, + "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfigurationResponse": { + "type": "structure", + "members": { + "PercentEnabled": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.
", + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration.
" + } + } + } + }, + "com.amazonaws.mediatailor#CreateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreateChannelRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreateChannelResponse" + }, + "traits": { + "smithy.api#documentation": "Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/channel/{ChannelName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#CreateChannelRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#httpLabel": {}, + "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The channel's output properties.
", + "smithy.api#required": {} + } + }, + "PlaybackMode": { + "target": "com.amazonaws.mediatailor#PlaybackMode", + "traits": { + "smithy.api#documentation": "The type of playback mode to use for this channel.
\n\n LINEAR - The programs in the schedule play once back-to-back in the schedule.
\n LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#Tier", + "traits": { + "smithy.api#documentation": "The tier of the channel.
" + } + }, + "TimeShiftConfiguration": { + "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", + "traits": { + "smithy.api#documentation": "\n The time-shifted viewing configuration you want to associate to the channel.\n
" + } + } + } + }, + "com.amazonaws.mediatailor#CreateChannelResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) to assign to the channel.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the channel.
" + } + }, + "ChannelState": { + "target": "com.amazonaws.mediatailor#ChannelState", + "traits": { + "smithy.api#documentation": "Indicates whether the channel is in a running state or not.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp of when the channel was created.
" + } + }, + "FillerSlate": { + "target": "com.amazonaws.mediatailor#SlateSource", + "traits": { + "smithy.api#documentation": "Contains information about the slate used to fill gaps between programs in the schedule.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp of when the channel was last modified.
" + } + }, + "Outputs": { + "target": "com.amazonaws.mediatailor#ResponseOutputs", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The output properties to assign to the channel.
", + "smithy.api#unstable": {} + } + }, + "PlaybackMode": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The playback mode to assign to the channel.
", + "smithy.api#unstable": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The tier of the channel.
", + "smithy.api#unstable": {} + } + }, + "TimeShiftConfiguration": { + "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", + "traits": { + "smithy.api#documentation": "\n The time-shifted viewing configuration assigned to the channel.\n
" + } + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreateLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreateLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "The live source configuration.
", + "smithy.api#http": { + "method": "POST", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#CreateLiveSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configuration parameters for this live source.
", + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#CreateLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN to assign to the live source.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the live source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configuration parameters for this live source.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the live source was last modified.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the live source.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the source location of the live source.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#CreatePrefetchSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleResponse" + }, + "traits": { + "smithy.api#documentation": "Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest": { + "type": "structure", + "members": { + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the schedule request.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
", + "smithy.api#required": {} + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
The ARN to assign to the prefetch schedule.
" + } + }, + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the prefetch schedule.
" + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the playback configuration.
" + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
" + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/channel/{ChannelName}/program/{ProgramName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#CreateProgramRequest": { + "type": "structure", + "members": { + "AdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfAdBreak", + "traits": { + "smithy.api#documentation": "The ad break configuration settings.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel for this Program.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the LiveSource for this Program.
" + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the Program.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.mediatailor#ScheduleConfiguration", + "traits": { + "smithy.api#documentation": "The schedule configuration settings.
", + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#required": {} + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that's used to refer to a VOD source.
" + } + } + } + }, + "com.amazonaws.mediatailor#CreateProgramResponse": { + "type": "structure", + "members": { + "AdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfAdBreak", + "traits": { + "smithy.api#documentation": "The ad break configuration settings.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN to assign to the program.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the channel for this program.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the program was created.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the LiveSource for this Program.
" + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to this program.
" + } + }, + "ScheduledStartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The scheduled start time for this Program.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the source location for this program.
" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that's used to refer to a VOD source.
" + } + }, + "ClipRange": { + "target": "com.amazonaws.mediatailor#ClipRange", + "traits": { + "smithy.api#documentation": "The clip range configuration settings.
" + } + }, + "DurationMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The duration of the live program in milliseconds.
" + } + } + } + }, + "com.amazonaws.mediatailor#CreateSourceLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreateSourceLocationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreateSourceLocationResponse" + }, + "traits": { + "smithy.api#documentation": "Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/sourceLocation/{SourceLocationName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#CreateSourceLocationRequest": { + "type": "structure", + "members": { + "AccessConfiguration": { + "target": "com.amazonaws.mediatailor#AccessConfiguration", + "traits": { + "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" + } + }, + "DefaultSegmentDeliveryConfiguration": { + "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The optional configuration for the server that serves segments.
" + } + }, + "HttpConfiguration": { + "target": "com.amazonaws.mediatailor#HttpConfiguration", + "traits": { + "smithy.api#documentation": "The source's HTTP package configurations.
", + "smithy.api#required": {} + } + }, + "SegmentDeliveryConfigurations": { + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name associated with the source location.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#CreateSourceLocationResponse": { + "type": "structure", + "members": { + "AccessConfiguration": { + "target": "com.amazonaws.mediatailor#AccessConfiguration", + "traits": { + "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN to assign to the source location.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the source location was created.
" + } + }, + "DefaultSegmentDeliveryConfiguration": { + "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The optional configuration for the server that serves segments.
" + } + }, + "HttpConfiguration": { + "target": "com.amazonaws.mediatailor#HttpConfiguration", + "traits": { + "smithy.api#documentation": "The source's HTTP package configurations.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the source location was last modified.
" + } + }, + "SegmentDeliveryConfigurations": { + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the source location.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#CreateVodSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreateVodSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreateVodSourceResponse" + }, + "traits": { + "smithy.api#documentation": "The VOD source configuration parameters.
", + "smithy.api#http": { + "method": "POST", + "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#CreateVodSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configuration parameters for this VOD source.
", + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location for this VOD source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name associated with the VOD source.>
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#CreateVodSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN to assign to this VOD source.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the VOD source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configuration parameters for this VOD source.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the VOD source was last modified.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the source location for this VOD source.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the VOD source.
" + } + } + } + }, + "com.amazonaws.mediatailor#DashConfiguration": { + "type": "structure", + "members": { + "ManifestEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
" + } + }, + "MpdLocation": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
The configuration for DASH content.
" + } + }, + "com.amazonaws.mediatailor#DashConfigurationForPut": { + "type": "structure", + "members": { + "MpdLocation": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
The configuration for DASH PUT operations.
" + } + }, + "com.amazonaws.mediatailor#DashPlaylistSettings": { + "type": "structure", + "members": { + "ManifestWindowSeconds": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
Dash manifest configuration parameters.
" + } + }, + "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration": { + "type": "structure", + "members": { + "BaseUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
" + } + }, + "com.amazonaws.mediatailor#DeleteChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteChannelRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteChannelResponse" + }, + "traits": { + "smithy.api#documentation": "Deletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channel/{ChannelName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#DeleteChannelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteChannelPolicyRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteChannelPolicyResponse" + }, + "traits": { + "smithy.api#documentation": "The channel policy to delete.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channel/{ChannelName}/policy", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#DeleteChannelPolicyRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel associated with this channel policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteChannelPolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DeleteChannelRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteChannelResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DeleteLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "The live source to delete.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#DeleteLiveSourceRequest": { + "type": "structure", + "members": { + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this Live Source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteLiveSourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DeletePlaybackConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeletePlaybackConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeletePlaybackConfigurationResponse" + }, + "traits": { + "smithy.api#documentation": "Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/playbackConfiguration/{Name}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#DeletePlaybackConfigurationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeletePlaybackConfigurationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DeletePrefetchSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse" + }, + "traits": { + "smithy.api#documentation": "Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration for this prefetch schedule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DeleteProgram": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteProgramRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteProgramResponse" + }, + "traits": { + "smithy.api#documentation": "Deletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/channel/{ChannelName}/program/{ProgramName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#DeleteProgramRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the program.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteProgramResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DeleteSourceLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteSourceLocationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteSourceLocationResponse" + }, + "traits": { + "smithy.api#documentation": "Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sourceLocation/{SourceLocationName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#DeleteSourceLocationRequest": { + "type": "structure", + "members": { + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteSourceLocationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DeleteVodSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeleteVodSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeleteVodSourceResponse" + }, + "traits": { + "smithy.api#documentation": "The video on demand (VOD) source to delete.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#DeleteVodSourceRequest": { + "type": "structure", + "members": { + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeleteVodSourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#DescribeChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DescribeChannelRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DescribeChannelResponse" + }, + "traits": { + "smithy.api#documentation": "Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/channel/{ChannelName}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#DescribeChannelRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DescribeChannelResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the channel.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
" + } + }, + "ChannelState": { + "target": "com.amazonaws.mediatailor#ChannelState", + "traits": { + "smithy.api#documentation": "Indicates whether the channel is in a running state or not.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp of when the channel was created.
" + } + }, + "FillerSlate": { + "target": "com.amazonaws.mediatailor#SlateSource", + "traits": { + "smithy.api#documentation": "Contains information about the slate used to fill gaps between programs in the schedule.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp of when the channel was last modified.
" + } + }, + "Outputs": { + "target": "com.amazonaws.mediatailor#ResponseOutputs", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The channel's output properties.
", + "smithy.api#unstable": {} + } + }, + "PlaybackMode": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The channel's playback mode.
", + "smithy.api#unstable": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The channel's tier.
", + "smithy.api#unstable": {} + } + }, + "LogConfiguration": { + "target": "com.amazonaws.mediatailor#LogConfigurationForChannel", + "traits": { + "smithy.api#documentation": "The log configuration for the channel.
", + "smithy.api#required": {} + } + }, + "TimeShiftConfiguration": { + "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", + "traits": { + "smithy.api#documentation": "\n The time-shifted viewing configuration for the channel.\n
" + } + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DescribeLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DescribeLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "The live source to describe.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#DescribeLiveSourceRequest": { + "type": "structure", + "members": { + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this Live Source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DescribeLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the live source.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "The HTTP package configurations.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the live source was modified.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with the live source.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#DescribeProgram": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DescribeProgramRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DescribeProgramResponse" + }, + "traits": { + "smithy.api#documentation": "Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/channel/{ChannelName}/program/{ProgramName}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#DescribeProgramRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel associated with this Program.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the program.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DescribeProgramResponse": { + "type": "structure", + "members": { + "AdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfAdBreak", + "traits": { + "smithy.api#documentation": "The ad break configuration settings.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the program.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel that the program belongs to.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp of when the program was created.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the LiveSource for this Program.
" + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the program.
" + } + }, + "ScheduledStartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The source location name.
" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that's used to refer to a VOD source.
" + } + }, + "ClipRange": { + "target": "com.amazonaws.mediatailor#ClipRange", + "traits": { + "smithy.api#documentation": "The clip range configuration settings.
" + } + }, + "DurationMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The duration of the live program in milliseconds.
" + } + } + } + }, + "com.amazonaws.mediatailor#DescribeSourceLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DescribeSourceLocationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DescribeSourceLocationResponse" + }, + "traits": { + "smithy.api#documentation": "Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#DescribeSourceLocationRequest": { + "type": "structure", + "members": { + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DescribeSourceLocationResponse": { + "type": "structure", + "members": { + "AccessConfiguration": { + "target": "com.amazonaws.mediatailor#AccessConfiguration", + "traits": { + "smithy.api#documentation": "The access configuration for the source location.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the source location.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" + } + }, + "DefaultSegmentDeliveryConfiguration": { + "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The default segment delivery configuration settings.
" + } + }, + "HttpConfiguration": { + "target": "com.amazonaws.mediatailor#HttpConfiguration", + "traits": { + "smithy.api#documentation": "The HTTP package configuration settings for the source location.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" + } + }, + "SegmentDeliveryConfigurations": { + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#DescribeVodSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DescribeVodSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DescribeVodSourceResponse" + }, + "traits": { + "smithy.api#documentation": "Provides details about a specific video on demand (VOD) source in a specific source location.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#DescribeVodSourceRequest": { + "type": "structure", + "members": { + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD Source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DescribeVodSourceResponse": { + "type": "structure", + "members": { + "AdBreakOpportunities": { + "target": "com.amazonaws.mediatailor#AdBreakOpportunities", + "traits": { + "smithy.api#documentation": "The ad break opportunities within the VOD source.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the VOD source.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "The HTTP package configurations.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The last modified time of the VOD source.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with the VOD source.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source.
" + } + } + } + }, + "com.amazonaws.mediatailor#FillPolicy": { + "type": "enum", + "members": { + "FULL_AVAIL_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_AVAIL_ONLY" + } + }, + "PARTIAL_AVAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL_AVAIL" + } + } + } + }, + "com.amazonaws.mediatailor#GetChannelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#GetChannelPolicyRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#GetChannelPolicyResponse" + }, + "traits": { + "smithy.api#documentation": "Returns the channel's IAM policy. IAM policies are used to control access to your channel.
", + "smithy.api#http": { + "method": "GET", + "uri": "/channel/{ChannelName}/policy", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#GetChannelPolicyRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel associated with this Channel Policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#GetChannelPolicyResponse": { + "type": "structure", + "members": { + "Policy": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The IAM policy for the channel. IAM policies are used to control access to your channel.
" + } + } + } + }, + "com.amazonaws.mediatailor#GetChannelSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#GetChannelScheduleRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#GetChannelScheduleResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves information about your channel's schedule.
", + "smithy.api#http": { + "method": "GET", + "uri": "/channel/{ChannelName}/schedule", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#GetChannelScheduleRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel associated with this Channel Schedule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DurationMinutes": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The duration in minutes of the channel schedule.
", + "smithy.api#httpQuery": "durationMinutes" + } + }, + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.
(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more channel schedules to get.
A list of schedule entries for the channel.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#GetPlaybackConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#GetPlaybackConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#GetPlaybackConfigurationResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", + "smithy.api#http": { + "method": "GET", + "uri": "/playbackConfiguration/{Name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#GetPlaybackConfigurationRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#GetPlaybackConfigurationResponse": { + "type": "structure", + "members": { + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
" + } + }, + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", + "traits": { + "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" + } + }, + "Bumper": { + "target": "com.amazonaws.mediatailor#Bumper", + "traits": { + "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" + } + }, + "CdnConfiguration": { + "target": "com.amazonaws.mediatailor#CdnConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" + } + }, + "ConfigurationAliases": { + "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", + "traits": { + "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" + } + }, + "DashConfiguration": { + "target": "com.amazonaws.mediatailor#DashConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for DASH content.
" + } + }, + "HlsConfiguration": { + "target": "com.amazonaws.mediatailor#HlsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for HLS content.
" + } + }, + "LivePreRollConfiguration": { + "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" + } + }, + "LogConfiguration": { + "target": "com.amazonaws.mediatailor#LogConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch log settings for a playback configuration.
" + } + }, + "ManifestProcessingRules": { + "target": "com.amazonaws.mediatailor#ManifestProcessingRules", + "traits": { + "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
" + } + }, + "PersonalizationThresholdSeconds": { + "target": "com.amazonaws.mediatailor#__integerMin1", + "traits": { + "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" + } + }, + "PlaybackConfigurationArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the playback configuration.
" + } + }, + "PlaybackEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
" + } + }, + "SessionInitializationEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL that the player uses to initialize a session that uses client-side reporting.
" + } + }, + "SlateAdUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "TranscodeProfileName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" + } + }, + "VideoContentSourceUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" + } + } + } + }, + "com.amazonaws.mediatailor#GetPrefetchSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#GetPrefetchScheduleRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#GetPrefetchScheduleResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#GetPrefetchScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
The Amazon Resource Name (ARN) of the prefetch schedule.
" + } + }, + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
" + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
" + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
" + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" + } + } + } + }, + "com.amazonaws.mediatailor#HlsConfiguration": { + "type": "structure", + "members": { + "ManifestEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for HLS content.
" + } + }, + "com.amazonaws.mediatailor#HlsPlaylistSettings": { + "type": "structure", + "members": { + "ManifestWindowSeconds": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
HLS playlist configuration parameters.
" + } + }, + "com.amazonaws.mediatailor#HttpConfiguration": { + "type": "structure", + "members": { + "BaseUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The base URL for the source location host server. This string must include the protocol, such as https://.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The HTTP configuration for the source location.
" + } + }, + "com.amazonaws.mediatailor#HttpPackageConfiguration": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
The streaming protocol for this package configuration. Supported values are HLS and DASH.
The HTTP package configuration properties for the requested VOD source.
" + } + }, + "com.amazonaws.mediatailor#HttpPackageConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#HttpPackageConfiguration" + }, + "traits": { + "smithy.api#documentation": "The VOD source's HTTP package configuration settings.
" + } + }, + "com.amazonaws.mediatailor#KeyValuePair": { + "type": "structure", + "members": { + "Key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a key, you must also specify a corresponding value.
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the EXT-X-ASSETtag. If you specify a value, you must also specify a corresponding key.
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the EXT-X-ASSETtag.
Lists the alerts that are associated with a MediaTailor channel assembly resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/alerts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#ListAlertsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than MaxResults alerts, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "ResourceArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#httpQuery": "resourceArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#ListAlertsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfAlert", + "traits": { + "smithy.api#documentation": "A list of alerts that are associated with this resource.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListChannels": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListChannelsRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListChannelsResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves information about the channels that are associated with the current AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/channels", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#ListChannelsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.mediatailor#ListChannelsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfChannel", + "traits": { + "smithy.api#documentation": "A list of channels that are associated with this account.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListLiveSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListLiveSourcesRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListLiveSourcesResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the live sources contained in a source location. A source represents a piece of content.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/liveSources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#ListLiveSourcesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this Live Sources list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#ListLiveSourcesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfLiveSource", + "traits": { + "smithy.api#documentation": "Lists the live sources.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListPlaybackConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListPlaybackConfigurationsRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListPlaybackConfigurationsResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
", + "smithy.api#http": { + "method": "GET", + "uri": "/playbackConfigurations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#ListPlaybackConfigurationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", + "smithy.api#httpQuery": "NextToken" + } + } + } + }, + "com.amazonaws.mediatailor#ListPlaybackConfigurationsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfPlaybackConfiguration", + "traits": { + "smithy.api#documentation": "Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListPrefetchSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the prefetch schedules for a playback configuration.
", + "smithy.api#http": { + "method": "POST", + "uri": "/prefetchSchedule/{PlaybackConfigurationName}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {}, + "smithy.api#suppress": [ + "HttpMethodSemantics" + ] + } + }, + "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#__integerMin1Max100", + "traits": { + "smithy.api#documentation": "The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.
(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.
For the first ListPrefetchSchedulesRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
Retrieves the prefetch schedule(s) for a specific playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfPrefetchSchedule", + "traits": { + "smithy.api#documentation": "Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListSourceLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListSourceLocationsRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListSourceLocationsResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#ListSourceLocationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": " The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than MaxResults source locations, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.mediatailor#ListSourceLocationsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfSourceLocation", + "traits": { + "smithy.api#documentation": "A list of source locations.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.mediatailor#BadRequestException" + } + ], + "traits": { + "smithy.api#documentation": "A list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with this resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#ListVodSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListVodSourcesRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListVodSourcesResponse" + }, + "traits": { + "smithy.api#documentation": "Lists the VOD sources contained in a source location. A source represents a piece of content.
", + "smithy.api#http": { + "method": "GET", + "uri": "/sourceLocation/{SourceLocationName}/vodSources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.mediatailor#ListVodSourcesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#MaxResults", + "traits": { + "smithy.api#documentation": " The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, use the value of NextToken in the response to get the next page of results.
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this VOD Source list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#ListVodSourcesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfVodSource", + "traits": { + "smithy.api#documentation": "Lists the VOD sources.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
" + } + } + } + }, + "com.amazonaws.mediatailor#LivePreRollConfiguration": { + "type": "structure", + "members": { + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
" + } + }, + "MaxDurationSeconds": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" + } + }, + "com.amazonaws.mediatailor#LiveSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN for the live source.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "The HTTP package configurations for the live source.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the live source was last modified.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that's used to refer to a live source.
", + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "Live source configuration parameters.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.mediatailor#LiveSourceResource" + } + ] + } + }, + "com.amazonaws.mediatailor#LiveSourceResource": { + "type": "resource", + "identifiers": { + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string" + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#CreateLiveSource" + }, + "read": { + "target": "com.amazonaws.mediatailor#DescribeLiveSource" + }, + "update": { + "target": "com.amazonaws.mediatailor#UpdateLiveSource" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeleteLiveSource" + }, + "list": { + "target": "com.amazonaws.mediatailor#ListLiveSources" + }, + "traits": { + "aws.api#arn": { + "template": "liveSource/{SourceLocationName}/{LiveSourceName}" + }, + "aws.cloudformation#cfnResource": { + "name": "LiveSource" + }, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.mediatailor#LogConfiguration": { + "type": "structure", + "members": { + "PercentEnabled": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100\n
Returns Amazon CloudWatch log settings for a playback configuration.
" + } + }, + "com.amazonaws.mediatailor#LogConfigurationForChannel": { + "type": "structure", + "members": { + "LogTypes": { + "target": "com.amazonaws.mediatailor#LogTypes", + "traits": { + "smithy.api#documentation": "The log types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The log configuration for the channel.
" + } + }, + "com.amazonaws.mediatailor#LogType": { + "type": "enum", + "members": { + "AS_RUN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AS_RUN" + } + } + } + }, + "com.amazonaws.mediatailor#LogTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#LogType" + } + }, + "com.amazonaws.mediatailor#ManifestProcessingRules": { + "type": "structure", + "members": { + "AdMarkerPassthrough": { + "target": "com.amazonaws.mediatailor#AdMarkerPassthrough", + "traits": { + "smithy.api#documentation": "For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" + } + }, + "com.amazonaws.mediatailor#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.mediatailor#MediaTailor": { + "type": "service", + "version": "2018-04-23", + "operations": [ + { + "target": "com.amazonaws.mediatailor#ConfigureLogsForPlaybackConfiguration" + }, + { + "target": "com.amazonaws.mediatailor#ListAlerts" + }, + { + "target": "com.amazonaws.mediatailor#ListTagsForResource" + }, + { + "target": "com.amazonaws.mediatailor#TagResource" + }, + { + "target": "com.amazonaws.mediatailor#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.mediatailor#ChannelResource" + }, + { + "target": "com.amazonaws.mediatailor#LiveSourceResource" + }, + { + "target": "com.amazonaws.mediatailor#PlaybackConfigurationResource" + }, + { + "target": "com.amazonaws.mediatailor#PrefetchScheduleResource" + }, + { + "target": "com.amazonaws.mediatailor#SourceLocationResource" + }, + { + "target": "com.amazonaws.mediatailor#VodSourceResource" + } + ], + "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#cors": { + "additionalAllowedHeaders": [ + "*", + "Authorization", + "Date", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amz-apigw-id", + "date" + ], + "maxAge": 86400 + }, + "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.
\nThrough 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", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://api.mediatailor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://api.mediatailor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://api.mediatailor.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.mediatailor#MessageType": { + "type": "enum", + "members": { + "SPLICE_INSERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPLICE_INSERT" + } + }, + "TIME_SIGNAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME_SIGNAL" + } + } + } + }, + "com.amazonaws.mediatailor#Mode": { + "type": "enum", + "members": { + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + }, + "BEHIND_LIVE_EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEHIND_LIVE_EDGE" + } + }, + "AFTER_LIVE_EDGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_LIVE_EDGE" + } + } + } + }, + "com.amazonaws.mediatailor#Operator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + } + } + }, + "com.amazonaws.mediatailor#OriginManifestType": { + "type": "enum", + "members": { + "SINGLE_PERIOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_PERIOD" + } + }, + "MULTI_PERIOD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_PERIOD" + } + } + } + }, + "com.amazonaws.mediatailor#PlaybackConfiguration": { + "type": "structure", + "members": { + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
" + } + }, + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", + "traits": { + "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" + } + }, + "Bumper": { + "target": "com.amazonaws.mediatailor#Bumper", + "traits": { + "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" + } + }, + "CdnConfiguration": { + "target": "com.amazonaws.mediatailor#CdnConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" + } + }, + "ConfigurationAliases": { + "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", + "traits": { + "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" + } + }, + "DashConfiguration": { + "target": "com.amazonaws.mediatailor#DashConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for a DASH source.
" + } + }, + "HlsConfiguration": { + "target": "com.amazonaws.mediatailor#HlsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for HLS content.
" + } + }, + "LivePreRollConfiguration": { + "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" + } + }, + "LogConfiguration": { + "target": "com.amazonaws.mediatailor#LogConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch log settings for a playback configuration.
" + } + }, + "ManifestProcessingRules": { + "target": "com.amazonaws.mediatailor#ManifestProcessingRules", + "traits": { + "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
" + } + }, + "PersonalizationThresholdSeconds": { + "target": "com.amazonaws.mediatailor#__integerMin1", + "traits": { + "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" + } + }, + "PlaybackConfigurationArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the playback configuration.
" + } + }, + "PlaybackEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
" + } + }, + "SessionInitializationEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL that the player uses to initialize a session that uses client-side reporting.
" + } + }, + "SlateAdUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "TranscodeProfileName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" + } + }, + "VideoContentSourceUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", + "smithy.api#references": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.mediatailor-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, + "resource": "com.amazonaws.mediatailor#PlaybackConfigurationResource" + } + ] + } + }, + "com.amazonaws.mediatailor#PlaybackConfigurationResource": { + "type": "resource", + "identifiers": { + "Name": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#PutPlaybackConfiguration" + }, + "read": { + "target": "com.amazonaws.mediatailor#GetPlaybackConfiguration" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeletePlaybackConfiguration" + }, + "list": { + "target": "com.amazonaws.mediatailor#ListPlaybackConfigurations" + }, + "traits": { + "aws.api#arn": { + "template": "playbackConfiguration/{Name}" + } + } + }, + "com.amazonaws.mediatailor#PlaybackMode": { + "type": "enum", + "members": { + "LOOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOOP" + } + }, + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAR" + } + } + } + }, + "com.amazonaws.mediatailor#PrefetchConsumption": { + "type": "structure", + "members": { + "AvailMatchingCriteria": { + "target": "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria", + "traits": { + "smithy.api#documentation": "If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
" + } + }, + "com.amazonaws.mediatailor#PrefetchRetrieval": { + "type": "structure", + "members": { + "DynamicVariables": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
\nYou initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
" + } + }, + "com.amazonaws.mediatailor#PrefetchSchedule": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prefetch schedule.
", + "smithy.api#required": {} + } + }, + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
", + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
", + "smithy.api#required": {} + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
", + "smithy.api#required": {} + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.mediatailor#PrefetchScheduleResource" + } + ] + } + }, + "com.amazonaws.mediatailor#PrefetchScheduleResource": { + "type": "resource", + "identifiers": { + "Name": { + "target": "com.amazonaws.mediatailor#__string" + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#CreatePrefetchSchedule" + }, + "read": { + "target": "com.amazonaws.mediatailor#GetPrefetchSchedule" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeletePrefetchSchedule" + }, + "list": { + "target": "com.amazonaws.mediatailor#ListPrefetchSchedules" + }, + "traits": { + "aws.api#arn": { + "template": "prefetchSchedule/{PlaybackConfigurationName}/{Name}" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.mediatailor#ProgramResource": { + "type": "resource", + "identifiers": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string" + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#CreateProgram" + }, + "read": { + "target": "com.amazonaws.mediatailor#DescribeProgram" + }, + "update": { + "target": "com.amazonaws.mediatailor#UpdateProgram" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeleteProgram" + }, + "traits": { + "aws.api#arn": { + "template": "program/{ChannelName}/{ProgramName}" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.mediatailor#PutChannelPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#PutChannelPolicyRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#PutChannelPolicyResponse" + }, + "traits": { + "smithy.api#documentation": "Creates an IAM policy for the channel. IAM policies are used to control access to your channel.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/channel/{ChannelName}/policy", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#PutChannelPolicyRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The channel name associated with this Channel Policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Policy": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Adds an IAM role that determines the permissions of your channel.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#PutChannelPolicyResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#PutPlaybackConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#PutPlaybackConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#PutPlaybackConfigurationResponse" + }, + "traits": { + "smithy.api#documentation": "Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/playbackConfiguration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#PutPlaybackConfigurationRequest": { + "type": "structure", + "members": { + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
" + } + }, + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", + "traits": { + "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" + } + }, + "Bumper": { + "target": "com.amazonaws.mediatailor#Bumper", + "traits": { + "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" + } + }, + "CdnConfiguration": { + "target": "com.amazonaws.mediatailor#CdnConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" + } + }, + "ConfigurationAliases": { + "target": "com.amazonaws.mediatailor#ConfigurationAliasesRequest", + "traits": { + "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" + } + }, + "DashConfiguration": { + "target": "com.amazonaws.mediatailor#DashConfigurationForPut", + "traits": { + "smithy.api#documentation": "The configuration for DASH content.
" + } + }, + "LivePreRollConfiguration": { + "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" + } + }, + "ManifestProcessingRules": { + "target": "com.amazonaws.mediatailor#ManifestProcessingRules", + "traits": { + "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
", + "smithy.api#required": {} + } + }, + "PersonalizationThresholdSeconds": { + "target": "com.amazonaws.mediatailor#__integerMin1", + "traits": { + "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" + } + }, + "SlateAdUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "TranscodeProfileName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" + } + }, + "VideoContentSourceUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" + } + } + } + }, + "com.amazonaws.mediatailor#PutPlaybackConfigurationResponse": { + "type": "structure", + "members": { + "AdDecisionServerUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
" + } + }, + "AvailSuppression": { + "target": "com.amazonaws.mediatailor#AvailSuppression", + "traits": { + "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" + } + }, + "Bumper": { + "target": "com.amazonaws.mediatailor#Bumper", + "traits": { + "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" + } + }, + "CdnConfiguration": { + "target": "com.amazonaws.mediatailor#CdnConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" + } + }, + "ConfigurationAliases": { + "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", + "traits": { + "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" + } + }, + "DashConfiguration": { + "target": "com.amazonaws.mediatailor#DashConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for DASH content.
" + } + }, + "HlsConfiguration": { + "target": "com.amazonaws.mediatailor#HlsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for HLS content.
" + } + }, + "LivePreRollConfiguration": { + "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" + } + }, + "LogConfiguration": { + "target": "com.amazonaws.mediatailor#LogConfiguration", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch log settings for a playback configuration.
" + } + }, + "ManifestProcessingRules": { + "target": "com.amazonaws.mediatailor#ManifestProcessingRules", + "traits": { + "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
" + } + }, + "PersonalizationThresholdSeconds": { + "target": "com.amazonaws.mediatailor#__integerMin1", + "traits": { + "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" + } + }, + "PlaybackConfigurationArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the playback configuration.
" + } + }, + "PlaybackEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The playback endpoint prefix associated with the playback configuration.
" + } + }, + "SessionInitializationEndpointPrefix": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The session initialization endpoint prefix associated with the playback configuration.
" + } + }, + "SlateAdUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "TranscodeProfileName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" + } + }, + "VideoContentSourceUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" + } + } + } + }, + "com.amazonaws.mediatailor#RelativePosition": { + "type": "enum", + "members": { + "BEFORE_PROGRAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEFORE_PROGRAM" + } + }, + "AFTER_PROGRAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_PROGRAM" + } + } + } + }, + "com.amazonaws.mediatailor#RequestOutputItem": { + "type": "structure", + "members": { + "DashPlaylistSettings": { + "target": "com.amazonaws.mediatailor#DashPlaylistSettings", + "traits": { + "smithy.api#documentation": "DASH manifest configuration parameters.
" + } + }, + "HlsPlaylistSettings": { + "target": "com.amazonaws.mediatailor#HlsPlaylistSettings", + "traits": { + "smithy.api#documentation": "HLS playlist configuration parameters.
" + } + }, + "ManifestName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the manifest for the channel. The name appears in the PlaybackUrl.
A string used to match which HttpPackageConfiguration is used for each VodSource.
The output configuration for this channel.
" + } + }, + "com.amazonaws.mediatailor#RequestOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#RequestOutputItem" + }, + "traits": { + "smithy.api#documentation": "An object that represents an object in the CreateChannel request.
" + } + }, + "com.amazonaws.mediatailor#ResponseOutputItem": { + "type": "structure", + "members": { + "DashPlaylistSettings": { + "target": "com.amazonaws.mediatailor#DashPlaylistSettings", + "traits": { + "smithy.api#documentation": "DASH manifest configuration settings.
" + } + }, + "HlsPlaylistSettings": { + "target": "com.amazonaws.mediatailor#HlsPlaylistSettings", + "traits": { + "smithy.api#documentation": "HLS manifest configuration settings.
" + } + }, + "ManifestName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the manifest for the channel that will appear in the channel output's playback URL.
", + "smithy.api#required": {} + } + }, + "PlaybackUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The URL used for playback by content players.
", + "smithy.api#required": {} + } + }, + "SourceGroup": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "A string used to associate a package configuration source group with a channel output.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The output item response.
" + } + }, + "com.amazonaws.mediatailor#ResponseOutputs": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#ResponseOutputItem" + } + }, + "com.amazonaws.mediatailor#ScheduleAdBreak": { + "type": "structure", + "members": { + "ApproximateDurationSeconds": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The approximate duration of the ad break, in seconds.
" + } + }, + "ApproximateStartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The approximate time that the ad will start playing.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location containing the VOD source used for the ad break.
" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source used for the ad break.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The schedule's ad break properties.
" + } + }, + "com.amazonaws.mediatailor#ScheduleConfiguration": { + "type": "structure", + "members": { + "Transition": { + "target": "com.amazonaws.mediatailor#Transition", + "traits": { + "smithy.api#documentation": "Program transition configurations.
", + "smithy.api#required": {} + } + }, + "ClipRange": { + "target": "com.amazonaws.mediatailor#ClipRange", + "traits": { + "smithy.api#documentation": "Program clip range configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
" + } + }, + "com.amazonaws.mediatailor#ScheduleEntry": { + "type": "structure", + "members": { + "ApproximateDurationSeconds": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The approximate duration of this program, in seconds.
" + } + }, + "ApproximateStartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The approximate time that the program will start playing.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the program.
", + "smithy.api#required": {} + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel that uses this schedule.
", + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source used for the program.
" + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the program.
", + "smithy.api#required": {} + } + }, + "ScheduleAdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfScheduleAdBreak", + "traits": { + "smithy.api#documentation": "The schedule's ad break properties.
" + } + }, + "ScheduleEntryType": { + "target": "com.amazonaws.mediatailor#ScheduleEntryType", + "traits": { + "smithy.api#documentation": "The type of schedule entry.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#required": {} + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties for a schedule.
" + } + }, + "com.amazonaws.mediatailor#ScheduleEntryType": { + "type": "enum", + "members": { + "PROGRAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROGRAM" + } + }, + "FILLER_SLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILLER_SLATE" + } + } + } + }, + "com.amazonaws.mediatailor#SecretsManagerAccessTokenConfiguration": { + "type": "structure", + "members": { + "HeaderName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the HTTP header used to supply the access token in requests to the source location.
" + } + }, + "SecretArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
" + } + }, + "SecretStringKey": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.
" + } + } + }, + "traits": { + "smithy.api#documentation": "AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.
" + } + }, + "com.amazonaws.mediatailor#SegmentDeliveryConfiguration": { + "type": "structure", + "members": { + "BaseUrl": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.
A unique identifier used to distinguish between multiple segment delivery configurations in a source location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The segment delivery configuration settings.
" + } + }, + "com.amazonaws.mediatailor#SegmentationDescriptor": { + "type": "structure", + "members": { + "SegmentationEventId": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is \"\" (an empty string).
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
\n segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
The name of the source location where the slate VOD source is stored.
" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Slate VOD source configuration.
" + } + }, + "com.amazonaws.mediatailor#SourceLocation": { + "type": "structure", + "members": { + "AccessConfiguration": { + "target": "com.amazonaws.mediatailor#AccessConfiguration", + "traits": { + "smithy.api#documentation": "The access configuration for the source location.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN of the SourceLocation.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" + } + }, + "DefaultSegmentDeliveryConfiguration": { + "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The default segment delivery configuration.
" + } + }, + "HttpConfiguration": { + "target": "com.amazonaws.mediatailor#HttpConfiguration", + "traits": { + "smithy.api#documentation": "The HTTP configuration for the source location.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" + } + }, + "SegmentDeliveryConfigurations": { + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The segment delivery configurations for the source location.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + }, + "traits": { + "smithy.api#documentation": "A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", + "smithy.api#references": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://api.mediatailor.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, + "resource": "com.amazonaws.mediatailor#SourceLocationResource" + } + ] + } + }, + "com.amazonaws.mediatailor#SourceLocationResource": { + "type": "resource", + "identifiers": { + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#CreateSourceLocation" + }, + "read": { + "target": "com.amazonaws.mediatailor#DescribeSourceLocation" + }, + "update": { + "target": "com.amazonaws.mediatailor#UpdateSourceLocation" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeleteSourceLocation" + }, + "list": { + "target": "com.amazonaws.mediatailor#ListSourceLocations" + }, + "traits": { + "aws.api#arn": { + "template": "sourceLocation/{SourceLocationName}" + }, + "aws.cloudformation#cfnResource": { + "name": "SourceLocation" + }, + "smithy.api#noReplace": {}, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.mediatailor#SpliceInsertMessage": { + "type": "structure", + "members": { + "AvailNum": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
Splice insert message configuration.
" + } + }, + "com.amazonaws.mediatailor#StartChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#StartChannelRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#StartChannelResponse" + }, + "traits": { + "smithy.api#documentation": "Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/channel/{ChannelName}/start", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#StartChannelRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#StartChannelResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#StopChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#StopChannelRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#StopChannelResponse" + }, + "traits": { + "smithy.api#documentation": "Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/channel/{ChannelName}/stop", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#StopChannelRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#StopChannelResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.mediatailor#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.mediatailor#BadRequestException" + } + ], + "traits": { + "smithy.api#documentation": "The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.mediatailor#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#Tier": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + } + }, + "com.amazonaws.mediatailor#TimeShiftConfiguration": { + "type": "structure", + "members": { + "MaxTimeDelaySeconds": { + "target": "com.amazonaws.mediatailor#__integer", + "traits": { + "smithy.api#documentation": "\n The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, \n and the maximum allowed maximum time delay is 21600 seconds (6 hours).\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The configuration for time-shifted viewing.\n
" + } + }, + "com.amazonaws.mediatailor#TimeSignalMessage": { + "type": "structure", + "members": { + "SegmentationDescriptors": { + "target": "com.amazonaws.mediatailor#SegmentationDescriptorList", + "traits": { + "smithy.api#documentation": "The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent.
The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06).
See the time_signal() table of the 2022 SCTE-35 specification for more information.
The duration of the live program in seconds.
" + } + }, + "RelativePosition": { + "target": "com.amazonaws.mediatailor#RelativePosition", + "traits": { + "smithy.api#documentation": "The position where this program will be inserted relative to the RelativePosition.
The name of the program that this program will be inserted next to, as defined by RelativePosition.
The date and time that the program is scheduled to start, in epoch milliseconds.
" + } + }, + "Type": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
\n ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR\n PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
\nIf there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
\n RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
Program transition configuration.
" + } + }, + "com.amazonaws.mediatailor#Type": { + "type": "enum", + "members": { + "DASH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASH" + } + }, + "HLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HLS" + } + } + } + }, + "com.amazonaws.mediatailor#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.mediatailor#BadRequestException" + } + ], + "traits": { + "smithy.api#documentation": "The resource to untag.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to untag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.mediatailor#__listOf__string", + "traits": { + "smithy.api#documentation": "The tag keys associated with the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#UpdateChannel": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UpdateChannelRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#UpdateChannelResponse" + }, + "traits": { + "smithy.api#documentation": "Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/channel/{ChannelName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#UpdateChannelRequest": { + "type": "structure", + "members": { + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
", + "smithy.api#httpLabel": {}, + "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The channel's output properties.
", + "smithy.api#required": {} + } + }, + "TimeShiftConfiguration": { + "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", + "traits": { + "smithy.api#documentation": "\n The time-shifted viewing configuration you want to associate to the channel.\n
" + } + } + } + }, + "com.amazonaws.mediatailor#UpdateChannelResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the channel.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel.
" + } + }, + "ChannelState": { + "target": "com.amazonaws.mediatailor#ChannelState", + "traits": { + "smithy.api#documentation": "Returns the state whether the channel is running or not.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp of when the channel was created.
" + } + }, + "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The timestamp that indicates when the channel was last modified.
" + } + }, + "Outputs": { + "target": "com.amazonaws.mediatailor#ResponseOutputs", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The channel's output properties.
", + "smithy.api#unstable": {} + } + }, + "PlaybackMode": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The type of playback mode for this channel.
\n\n LINEAR - Programs play back-to-back only once.
\n LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "Tier": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The tier associated with this Channel.
", + "smithy.api#unstable": {} + } + }, + "TimeShiftConfiguration": { + "target": "com.amazonaws.mediatailor#TimeShiftConfiguration", + "traits": { + "smithy.api#documentation": "\n The time-shifted viewing configuration for the channel.\n
" + } + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UpdateLiveSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#UpdateLiveSourceResponse" + }, + "traits": { + "smithy.api#documentation": "Updates a live source's configuration.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#UpdateLiveSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configurations for the live source on this account.
", + "smithy.api#required": {} + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this Live Source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#UpdateLiveSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with this live source.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configurations for the live source on this account.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the live source was last modified.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with the live source.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#UpdateProgram": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UpdateProgramRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#UpdateProgramResponse" + }, + "traits": { + "smithy.api#documentation": "Updates a program within a channel.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/channel/{ChannelName}/program/{ProgramName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#UpdateProgramRequest": { + "type": "structure", + "members": { + "AdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfAdBreak", + "traits": { + "smithy.api#documentation": "The ad break configuration settings.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the channel for this Program.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the Program.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleConfiguration": { + "target": "com.amazonaws.mediatailor#UpdateProgramScheduleConfiguration", + "traits": { + "smithy.api#documentation": "The schedule configuration settings.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#UpdateProgramResponse": { + "type": "structure", + "members": { + "AdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfAdBreak", + "traits": { + "smithy.api#documentation": "The ad break configuration settings.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN to assign to the program.
" + } + }, + "ChannelName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the channel for this program.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time the program was created.
" + } + }, + "ProgramName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to this program.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name to assign to the source location for this program.
" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name that's used to refer to a VOD source.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the LiveSource for this Program.
" + } + }, + "ClipRange": { + "target": "com.amazonaws.mediatailor#ClipRange", + "traits": { + "smithy.api#documentation": "The clip range configuration settings.
" + } + }, + "DurationMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The duration of the live program in milliseconds.
" + } + }, + "ScheduledStartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The scheduled start time for this Program.
" + } + } + } + }, + "com.amazonaws.mediatailor#UpdateProgramScheduleConfiguration": { + "type": "structure", + "members": { + "Transition": { + "target": "com.amazonaws.mediatailor#UpdateProgramTransition", + "traits": { + "smithy.api#documentation": "Program transition configuration.
" + } + }, + "ClipRange": { + "target": "com.amazonaws.mediatailor#ClipRange", + "traits": { + "smithy.api#documentation": "Program clip range configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Schedule configuration parameters.
" + } + }, + "com.amazonaws.mediatailor#UpdateProgramTransition": { + "type": "structure", + "members": { + "ScheduledStartTimeMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The date and time that the program is scheduled to start, in epoch milliseconds.
" + } + }, + "DurationMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The duration of the live program in seconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Program transition configuration.
" + } + }, + "com.amazonaws.mediatailor#UpdateSourceLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UpdateSourceLocationRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#UpdateSourceLocationResponse" + }, + "traits": { + "smithy.api#documentation": "Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/sourceLocation/{SourceLocationName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#UpdateSourceLocationRequest": { + "type": "structure", + "members": { + "AccessConfiguration": { + "target": "com.amazonaws.mediatailor#AccessConfiguration", + "traits": { + "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" + } + }, + "DefaultSegmentDeliveryConfiguration": { + "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The optional configuration for the host server that serves segments.
" + } + }, + "HttpConfiguration": { + "target": "com.amazonaws.mediatailor#HttpConfiguration", + "traits": { + "smithy.api#documentation": "The HTTP configuration for the source location.
", + "smithy.api#required": {} + } + }, + "SegmentDeliveryConfigurations": { + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#UpdateSourceLocationResponse": { + "type": "structure", + "members": { + "AccessConfiguration": { + "target": "com.amazonaws.mediatailor#AccessConfiguration", + "traits": { + "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" + } + }, + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the source location.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" + } + }, + "DefaultSegmentDeliveryConfiguration": { + "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The optional configuration for the host server that serves segments.
" + } + }, + "HttpConfiguration": { + "target": "com.amazonaws.mediatailor#HttpConfiguration", + "traits": { + "smithy.api#documentation": "The HTTP configuration for the source location.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" + } + }, + "SegmentDeliveryConfigurations": { + "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", + "traits": { + "smithy.api#documentation": "The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + } + } + }, + "com.amazonaws.mediatailor#UpdateVodSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#UpdateVodSourceRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#UpdateVodSourceResponse" + }, + "traits": { + "smithy.api#documentation": "Updates a VOD source's configuration.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.mediatailor#UpdateVodSourceRequest": { + "type": "structure", + "members": { + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configurations for the VOD source on this account.
", + "smithy.api#required": {} + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#UpdateVodSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the VOD source.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "A list of HTTP package configurations for the VOD source on this account.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the VOD source was last modified.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location associated with the VOD source.
" + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source.
" + } + } + } + }, + "com.amazonaws.mediatailor#VodSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The ARN for the VOD source.
", + "smithy.api#required": {} + } + }, + "CreationTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" + } + }, + "HttpPackageConfigurations": { + "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", + "traits": { + "smithy.api#documentation": "The HTTP package configurations for the VOD source.
", + "smithy.api#required": {} + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp that indicates when the VOD source was last modified.
" + } + }, + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the source location that the VOD source is associated with.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", + "smithy.api#jsonName": "tags" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "VOD source configuration parameters.
", + "smithy.api#references": [ { - "conditions": [], - "endpoint": { - "url": "https://api.mediatailor.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://api.mediatailor.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.mediatailor#MessageType": { - "type": "enum", - "members": { - "SPLICE_INSERT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPLICE_INSERT" - } - }, - "TIME_SIGNAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIME_SIGNAL" - } - } - } - }, - "com.amazonaws.mediatailor#Mode": { - "type": "enum", - "members": { - "OFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OFF" - } - }, - "BEHIND_LIVE_EDGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BEHIND_LIVE_EDGE" - } - }, - "AFTER_LIVE_EDGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFTER_LIVE_EDGE" - } - } - } - }, - "com.amazonaws.mediatailor#Operator": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - } - } - }, - "com.amazonaws.mediatailor#OriginManifestType": { - "type": "enum", - "members": { - "SINGLE_PERIOD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_PERIOD" - } - }, - "MULTI_PERIOD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_PERIOD" - } - } - } - }, - "com.amazonaws.mediatailor#PlaybackConfiguration": { - "type": "structure", - "members": { - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
" - } - }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", - "traits": { - "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" - } - }, - "Bumper": { - "target": "com.amazonaws.mediatailor#Bumper", - "traits": { - "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" - } - }, - "CdnConfiguration": { - "target": "com.amazonaws.mediatailor#CdnConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" - } - }, - "ConfigurationAliases": { - "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", - "traits": { - "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" - } - }, - "DashConfiguration": { - "target": "com.amazonaws.mediatailor#DashConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for a DASH source.
" - } - }, - "HlsConfiguration": { - "target": "com.amazonaws.mediatailor#HlsConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for HLS content.
" - } - }, - "LivePreRollConfiguration": { - "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" - } - }, - "LogConfiguration": { - "target": "com.amazonaws.mediatailor#LogConfiguration", - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch log settings for a playback configuration.
" - } - }, - "ManifestProcessingRules": { - "target": "com.amazonaws.mediatailor#ManifestProcessingRules", - "traits": { - "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The identifier for the playback configuration.
" - } - }, - "PersonalizationThresholdSeconds": { - "target": "com.amazonaws.mediatailor#__integerMin1", - "traits": { - "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" - } - }, - "PlaybackConfigurationArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the playback configuration.
" - } - }, - "PlaybackEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
" - } - }, - "SessionInitializationEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL that the player uses to initialize a session that uses client-side reporting.
" - } - }, - "SlateAdUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "TranscodeProfileName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" - } - }, - "VideoContentSourceUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.mediatailor#PlaybackConfigurationResource" - } - ] - } - }, - "com.amazonaws.mediatailor#PlaybackConfigurationResource": { - "type": "resource", - "identifiers": { - "Name": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#PutPlaybackConfiguration" - }, - "read": { - "target": "com.amazonaws.mediatailor#GetPlaybackConfiguration" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeletePlaybackConfiguration" - }, - "list": { - "target": "com.amazonaws.mediatailor#ListPlaybackConfigurations" - }, - "traits": { - "aws.api#arn": { - "template": "playbackConfiguration/{Name}" - } - } - }, - "com.amazonaws.mediatailor#PlaybackMode": { - "type": "enum", - "members": { - "LOOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOOP" - } - }, - "LINEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINEAR" - } - } - } - }, - "com.amazonaws.mediatailor#PrefetchConsumption": { - "type": "structure", - "members": { - "AvailMatchingCriteria": { - "target": "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria", - "traits": { - "smithy.api#documentation": "If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
" - } - }, - "com.amazonaws.mediatailor#PrefetchRetrieval": { - "type": "structure", - "members": { - "DynamicVariables": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
\nYou initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
" - } - }, - "com.amazonaws.mediatailor#PrefetchSchedule": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prefetch schedule.
", - "smithy.api#required": {} - } - }, - "Consumption": { - "target": "com.amazonaws.mediatailor#PrefetchConsumption", - "traits": { - "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
", - "smithy.api#required": {} - } - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
", - "smithy.api#required": {} - } - }, - "Retrieval": { - "target": "com.amazonaws.mediatailor#PrefetchRetrieval", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
", - "smithy.api#required": {} - } - }, - "StreamId": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.mediatailor#PrefetchScheduleResource" - } - ] - } - }, - "com.amazonaws.mediatailor#PrefetchScheduleResource": { - "type": "resource", - "identifiers": { - "Name": { - "target": "com.amazonaws.mediatailor#__string" - }, - "PlaybackConfigurationName": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#CreatePrefetchSchedule" - }, - "read": { - "target": "com.amazonaws.mediatailor#GetPrefetchSchedule" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeletePrefetchSchedule" - }, - "list": { - "target": "com.amazonaws.mediatailor#ListPrefetchSchedules" - }, - "traits": { - "aws.api#arn": { - "template": "prefetchSchedule/{PlaybackConfigurationName}/{Name}" - }, - "smithy.api#noReplace": {} - } - }, - "com.amazonaws.mediatailor#ProgramResource": { - "type": "resource", - "identifiers": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string" - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#CreateProgram" - }, - "read": { - "target": "com.amazonaws.mediatailor#DescribeProgram" - }, - "update": { - "target": "com.amazonaws.mediatailor#UpdateProgram" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeleteProgram" - }, - "traits": { - "aws.api#arn": { - "template": "program/{ChannelName}/{ProgramName}" - }, - "smithy.api#noReplace": {} - } - }, - "com.amazonaws.mediatailor#PutChannelPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#PutChannelPolicyRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#PutChannelPolicyResponse" - }, - "traits": { - "smithy.api#documentation": "Creates an IAM policy for the channel. IAM policies are used to control access to your channel.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/channel/{ChannelName}/policy", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#PutChannelPolicyRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The channel name associated with this Channel Policy.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Policy": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Adds an IAM role that determines the permissions of your channel.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#PutChannelPolicyResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#PutPlaybackConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#PutPlaybackConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#PutPlaybackConfigurationResponse" - }, - "traits": { - "smithy.api#documentation": "Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/playbackConfiguration", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#PutPlaybackConfigurationRequest": { - "type": "structure", - "members": { - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
" - } - }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", - "traits": { - "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" - } - }, - "Bumper": { - "target": "com.amazonaws.mediatailor#Bumper", - "traits": { - "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" - } - }, - "CdnConfiguration": { - "target": "com.amazonaws.mediatailor#CdnConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" - } - }, - "ConfigurationAliases": { - "target": "com.amazonaws.mediatailor#ConfigurationAliasesRequest", - "traits": { - "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" - } - }, - "DashConfiguration": { - "target": "com.amazonaws.mediatailor#DashConfigurationForPut", - "traits": { - "smithy.api#documentation": "The configuration for DASH content.
" - } - }, - "LivePreRollConfiguration": { - "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" - } - }, - "ManifestProcessingRules": { - "target": "com.amazonaws.mediatailor#ManifestProcessingRules", - "traits": { - "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The identifier for the playback configuration.
", - "smithy.api#required": {} - } - }, - "PersonalizationThresholdSeconds": { - "target": "com.amazonaws.mediatailor#__integerMin1", - "traits": { - "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" - } - }, - "SlateAdUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "TranscodeProfileName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" - } - }, - "VideoContentSourceUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" - } - } - } - }, - "com.amazonaws.mediatailor#PutPlaybackConfigurationResponse": { - "type": "structure", - "members": { - "AdDecisionServerUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
" - } - }, - "AvailSuppression": { - "target": "com.amazonaws.mediatailor#AvailSuppression", - "traits": { - "smithy.api#documentation": "The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
" - } - }, - "Bumper": { - "target": "com.amazonaws.mediatailor#Bumper", - "traits": { - "smithy.api#documentation": "The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
" - } - }, - "CdnConfiguration": { - "target": "com.amazonaws.mediatailor#CdnConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
" - } - }, - "ConfigurationAliases": { - "target": "com.amazonaws.mediatailor#ConfigurationAliasesResponse", - "traits": { - "smithy.api#documentation": "The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
" - } - }, - "DashConfiguration": { - "target": "com.amazonaws.mediatailor#DashConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for DASH content.
" - } - }, - "HlsConfiguration": { - "target": "com.amazonaws.mediatailor#HlsConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for HLS content.
" - } - }, - "LivePreRollConfiguration": { - "target": "com.amazonaws.mediatailor#LivePreRollConfiguration", - "traits": { - "smithy.api#documentation": "The configuration for pre-roll ad insertion.
" - } - }, - "LogConfiguration": { - "target": "com.amazonaws.mediatailor#LogConfiguration", - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch log settings for a playback configuration.
" - } - }, - "ManifestProcessingRules": { - "target": "com.amazonaws.mediatailor#ManifestProcessingRules", - "traits": { - "smithy.api#documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
" - } - }, - "Name": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The identifier for the playback configuration.
" - } - }, - "PersonalizationThresholdSeconds": { - "target": "com.amazonaws.mediatailor#__integerMin1", - "traits": { - "smithy.api#documentation": "Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
" - } - }, - "PlaybackConfigurationArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the playback configuration.
" - } - }, - "PlaybackEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The playback endpoint prefix associated with the playback configuration.
" - } - }, - "SessionInitializationEndpointPrefix": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The session initialization endpoint prefix associated with the playback configuration.
" - } - }, - "SlateAdUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "TranscodeProfileName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
" - } - }, - "VideoContentSourceUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
" - } - } - } - }, - "com.amazonaws.mediatailor#RelativePosition": { - "type": "enum", - "members": { - "BEFORE_PROGRAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BEFORE_PROGRAM" - } - }, - "AFTER_PROGRAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFTER_PROGRAM" - } - } - } - }, - "com.amazonaws.mediatailor#RequestOutputItem": { - "type": "structure", - "members": { - "DashPlaylistSettings": { - "target": "com.amazonaws.mediatailor#DashPlaylistSettings", - "traits": { - "smithy.api#documentation": "DASH manifest configuration parameters.
" - } - }, - "HlsPlaylistSettings": { - "target": "com.amazonaws.mediatailor#HlsPlaylistSettings", - "traits": { - "smithy.api#documentation": "HLS playlist configuration parameters.
" - } - }, - "ManifestName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the manifest for the channel. The name appears in the PlaybackUrl.
A string used to match which HttpPackageConfiguration is used for each VodSource.
The output configuration for this channel.
" - } - }, - "com.amazonaws.mediatailor#RequestOutputs": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#RequestOutputItem" - }, - "traits": { - "smithy.api#documentation": "An object that represents an object in the CreateChannel request.
" - } - }, - "com.amazonaws.mediatailor#ResponseOutputItem": { - "type": "structure", - "members": { - "DashPlaylistSettings": { - "target": "com.amazonaws.mediatailor#DashPlaylistSettings", - "traits": { - "smithy.api#documentation": "DASH manifest configuration settings.
" - } - }, - "HlsPlaylistSettings": { - "target": "com.amazonaws.mediatailor#HlsPlaylistSettings", - "traits": { - "smithy.api#documentation": "HLS manifest configuration settings.
" - } - }, - "ManifestName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the manifest for the channel that will appear in the channel output's playback URL.
", - "smithy.api#required": {} - } - }, - "PlaybackUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The URL used for playback by content players.
", - "smithy.api#required": {} - } - }, - "SourceGroup": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "A string used to associate a package configuration source group with a channel output.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The output item response.
" - } - }, - "com.amazonaws.mediatailor#ResponseOutputs": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#ResponseOutputItem" - } - }, - "com.amazonaws.mediatailor#ScheduleAdBreak": { - "type": "structure", - "members": { - "ApproximateDurationSeconds": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#documentation": "The approximate duration of the ad break, in seconds.
" - } - }, - "ApproximateStartTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The approximate time that the ad will start playing.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location containing the VOD source used for the ad break.
" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD source used for the ad break.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The schedule's ad break properties.
" - } - }, - "com.amazonaws.mediatailor#ScheduleConfiguration": { - "type": "structure", - "members": { - "Transition": { - "target": "com.amazonaws.mediatailor#Transition", - "traits": { - "smithy.api#documentation": "Program transition configurations.
", - "smithy.api#required": {} - } - }, - "ClipRange": { - "target": "com.amazonaws.mediatailor#ClipRange", - "traits": { - "smithy.api#documentation": "Program clip range configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
" - } - }, - "com.amazonaws.mediatailor#ScheduleEntry": { - "type": "structure", - "members": { - "ApproximateDurationSeconds": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#documentation": "The approximate duration of this program, in seconds.
" - } - }, - "ApproximateStartTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The approximate time that the program will start playing.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the program.
", - "smithy.api#required": {} - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel that uses this schedule.
", - "smithy.api#required": {} - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the live source used for the program.
" - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the program.
", - "smithy.api#required": {} - } - }, - "ScheduleAdBreaks": { - "target": "com.amazonaws.mediatailor#__listOfScheduleAdBreak", - "traits": { - "smithy.api#documentation": "The schedule's ad break properties.
" - } - }, - "ScheduleEntryType": { - "target": "com.amazonaws.mediatailor#ScheduleEntryType", - "traits": { - "smithy.api#documentation": "The type of schedule entry.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#required": {} - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD source.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The properties for a schedule.
" - } - }, - "com.amazonaws.mediatailor#ScheduleEntryType": { - "type": "enum", - "members": { - "PROGRAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROGRAM" - } - }, - "FILLER_SLATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILLER_SLATE" - } - } - } - }, - "com.amazonaws.mediatailor#SecretsManagerAccessTokenConfiguration": { - "type": "structure", - "members": { - "HeaderName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the HTTP header used to supply the access token in requests to the source location.
" - } - }, - "SecretArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
" - } - }, - "SecretStringKey": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.
" - } - } - }, - "traits": { - "smithy.api#documentation": "AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.
" - } - }, - "com.amazonaws.mediatailor#SegmentDeliveryConfiguration": { - "type": "structure", - "members": { - "BaseUrl": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.
A unique identifier used to distinguish between multiple segment delivery configurations in a source location.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The segment delivery configuration settings.
" - } - }, - "com.amazonaws.mediatailor#SegmentationDescriptor": { - "type": "structure", - "members": { - "SegmentationEventId": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is \"\" (an empty string).
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
\n segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
The name of the source location where the slate VOD source is stored.
" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Slate VOD source configuration.
" - } - }, - "com.amazonaws.mediatailor#SourceLocation": { - "type": "structure", - "members": { - "AccessConfiguration": { - "target": "com.amazonaws.mediatailor#AccessConfiguration", - "traits": { - "smithy.api#documentation": "The access configuration for the source location.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN of the SourceLocation.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" - } - }, - "DefaultSegmentDeliveryConfiguration": { - "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The default segment delivery configuration.
" - } - }, - "HttpConfiguration": { - "target": "com.amazonaws.mediatailor#HttpConfiguration", - "traits": { - "smithy.api#documentation": "The HTTP configuration for the source location.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" - } - }, - "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The segment delivery configurations for the source location.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - }, - "traits": { - "smithy.api#documentation": "A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.mediatailor#SourceLocationResource" - } - ] - } - }, - "com.amazonaws.mediatailor#SourceLocationResource": { - "type": "resource", - "identifiers": { - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#CreateSourceLocation" - }, - "read": { - "target": "com.amazonaws.mediatailor#DescribeSourceLocation" - }, - "update": { - "target": "com.amazonaws.mediatailor#UpdateSourceLocation" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeleteSourceLocation" - }, - "list": { - "target": "com.amazonaws.mediatailor#ListSourceLocations" - }, - "traits": { - "aws.api#arn": { - "template": "sourceLocation/{SourceLocationName}" - }, - "aws.cloudformation#cfnResource": { - "name": "SourceLocation" - }, - "smithy.api#noReplace": {}, - "smithy.api#unstable": {} - } - }, - "com.amazonaws.mediatailor#SpliceInsertMessage": { - "type": "structure", - "members": { - "AvailNum": { - "target": "com.amazonaws.mediatailor#__integer", - "traits": { - "smithy.api#documentation": "This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
Splice insert message configuration.
" - } - }, - "com.amazonaws.mediatailor#StartChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#StartChannelRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#StartChannelResponse" - }, - "traits": { - "smithy.api#documentation": "Starts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/channel/{ChannelName}/start", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#StartChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#StartChannelResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#StopChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#StopChannelRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#StopChannelResponse" - }, - "traits": { - "smithy.api#documentation": "Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/channel/{ChannelName}/stop", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#StopChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#StopChannelResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.mediatailor#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#TagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.mediatailor#BadRequestException" - } - ], - "traits": { - "smithy.api#documentation": "The resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{ResourceArn}", - "code": 204 - } - } - }, - "com.amazonaws.mediatailor#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the resource.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#Tier": { - "type": "enum", - "members": { - "BASIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BASIC" - } - }, - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - } - } - }, - "com.amazonaws.mediatailor#TimeSignalMessage": { - "type": "structure", - "members": { - "SegmentationDescriptors": { - "target": "com.amazonaws.mediatailor#SegmentationDescriptorList", - "traits": { - "smithy.api#documentation": "The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent.
The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06).
See the time_signal() table of the 2022 SCTE-35 specification for more information.
The duration of the live program in seconds.
" - } - }, - "RelativePosition": { - "target": "com.amazonaws.mediatailor#RelativePosition", - "traits": { - "smithy.api#documentation": "The position where this program will be inserted relative to the RelativePosition.
The name of the program that this program will be inserted next to, as defined by RelativePosition.
The date and time that the program is scheduled to start, in epoch milliseconds.
" - } - }, - "Type": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
\n ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR\n PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
\nIf there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
\n RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
Program transition configuration.
" - } - }, - "com.amazonaws.mediatailor#Type": { - "type": "enum", - "members": { - "DASH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASH" - } - }, - "HLS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HLS" - } - } - } - }, - "com.amazonaws.mediatailor#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#UntagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.mediatailor#BadRequestException" - } - ], - "traits": { - "smithy.api#documentation": "The resource to untag.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{ResourceArn}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to untag.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.mediatailor#__listOf__string", - "traits": { - "smithy.api#documentation": "The tag keys associated with the resource.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#UpdateChannel": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#UpdateChannelRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#UpdateChannelResponse" - }, - "traits": { - "smithy.api#documentation": "Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/channel/{ChannelName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#UpdateChannelRequest": { - "type": "structure", - "members": { - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
", - "smithy.api#httpLabel": {}, - "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The channel's output properties.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#UpdateChannelResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the channel.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel.
" - } - }, - "ChannelState": { - "target": "com.amazonaws.mediatailor#ChannelState", - "traits": { - "smithy.api#documentation": "Returns the state whether the channel is running or not.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp of when the channel was created.
" - } - }, - "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\n PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP\n PlaybackMode.
The timestamp that indicates when the channel was last modified.
" - } - }, - "Outputs": { - "target": "com.amazonaws.mediatailor#ResponseOutputs", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The channel's output properties.
", - "smithy.api#unstable": {} - } - }, - "PlaybackMode": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The type of playback mode for this channel.
\n\n LINEAR - Programs play back-to-back only once.
\n LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "Tier": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "The tier associated with this Channel.
", - "smithy.api#unstable": {} - } - } - } - }, - "com.amazonaws.mediatailor#UpdateLiveSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#UpdateLiveSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#UpdateLiveSourceResponse" - }, - "traits": { - "smithy.api#documentation": "Updates a live source's configuration.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#UpdateLiveSourceRequest": { - "type": "structure", - "members": { - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configurations for the live source on this account.
", - "smithy.api#required": {} - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the live source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this Live Source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#UpdateLiveSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with this live source.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the live source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configurations for the live source on this account.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the live source was last modified.
" - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the live source.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with the live source.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#UpdateProgram": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#UpdateProgramRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#UpdateProgramResponse" - }, - "traits": { - "smithy.api#documentation": "Updates a program within a channel.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/channel/{ChannelName}/program/{ProgramName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#UpdateProgramRequest": { - "type": "structure", - "members": { - "AdBreaks": { - "target": "com.amazonaws.mediatailor#__listOfAdBreak", - "traits": { - "smithy.api#documentation": "The ad break configuration settings.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the channel for this Program.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the Program.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ScheduleConfiguration": { - "target": "com.amazonaws.mediatailor#UpdateProgramScheduleConfiguration", - "traits": { - "smithy.api#documentation": "The schedule configuration settings.
", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#UpdateProgramResponse": { - "type": "structure", - "members": { - "AdBreaks": { - "target": "com.amazonaws.mediatailor#__listOfAdBreak", - "traits": { - "smithy.api#documentation": "The ad break configuration settings.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN to assign to the program.
" - } - }, - "ChannelName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the channel for this program.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time the program was created.
" - } - }, - "ProgramName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to this program.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name to assign to the source location for this program.
" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name that's used to refer to a VOD source.
" - } - }, - "LiveSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the LiveSource for this Program.
" - } - }, - "ClipRange": { - "target": "com.amazonaws.mediatailor#ClipRange", - "traits": { - "smithy.api#documentation": "The clip range configuration settings.
" - } - }, - "DurationMillis": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#documentation": "The duration of the live program in milliseconds.
" - } - }, - "ScheduledStartTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The scheduled start time for this Program.
" - } - } - } - }, - "com.amazonaws.mediatailor#UpdateProgramScheduleConfiguration": { - "type": "structure", - "members": { - "Transition": { - "target": "com.amazonaws.mediatailor#UpdateProgramTransition", - "traits": { - "smithy.api#documentation": "Program transition configuration.
" - } - }, - "ClipRange": { - "target": "com.amazonaws.mediatailor#ClipRange", - "traits": { - "smithy.api#documentation": "Program clip range configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Schedule configuration parameters.
" - } - }, - "com.amazonaws.mediatailor#UpdateProgramTransition": { - "type": "structure", - "members": { - "ScheduledStartTimeMillis": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#documentation": "The date and time that the program is scheduled to start, in epoch milliseconds.
" - } - }, - "DurationMillis": { - "target": "com.amazonaws.mediatailor#__long", - "traits": { - "smithy.api#documentation": "The duration of the live program in seconds.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Program transition configuration.
" - } - }, - "com.amazonaws.mediatailor#UpdateSourceLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#UpdateSourceLocationRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#UpdateSourceLocationResponse" - }, - "traits": { - "smithy.api#documentation": "Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/sourceLocation/{SourceLocationName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#UpdateSourceLocationRequest": { - "type": "structure", - "members": { - "AccessConfiguration": { - "target": "com.amazonaws.mediatailor#AccessConfiguration", - "traits": { - "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" - } - }, - "DefaultSegmentDeliveryConfiguration": { - "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The optional configuration for the host server that serves segments.
" - } - }, - "HttpConfiguration": { - "target": "com.amazonaws.mediatailor#HttpConfiguration", - "traits": { - "smithy.api#documentation": "The HTTP configuration for the source location.
", - "smithy.api#required": {} - } - }, - "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "A list of the segment delivery configurations associated with this resource.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#UpdateSourceLocationResponse": { - "type": "structure", - "members": { - "AccessConfiguration": { - "target": "com.amazonaws.mediatailor#AccessConfiguration", - "traits": { - "smithy.api#documentation": "Access configuration parameters. Configures the type of authentication used to access content from your source location.
" - } - }, - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the source location.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the source location was created.
" - } - }, - "DefaultSegmentDeliveryConfiguration": { - "target": "com.amazonaws.mediatailor#DefaultSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The optional configuration for the host server that serves segments.
" - } - }, - "HttpConfiguration": { - "target": "com.amazonaws.mediatailor#HttpConfiguration", - "traits": { - "smithy.api#documentation": "The HTTP configuration for the source location.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the source location was last modified.
" - } - }, - "SegmentDeliveryConfigurations": { - "target": "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration", - "traits": { - "smithy.api#documentation": "The segment delivery configurations for the source location. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - } - } - }, - "com.amazonaws.mediatailor#UpdateVodSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.mediatailor#UpdateVodSourceRequest" - }, - "output": { - "target": "com.amazonaws.mediatailor#UpdateVodSourceResponse" - }, - "traits": { - "smithy.api#documentation": "Updates a VOD source's configuration.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.mediatailor#UpdateVodSourceRequest": { - "type": "structure", - "members": { - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configurations for the VOD source on this account.
", - "smithy.api#required": {} - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with this VOD Source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD source.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.mediatailor#UpdateVodSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the VOD source.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "A list of HTTP package configurations for the VOD source on this account.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the VOD source was last modified.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location associated with the VOD source.
" - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD source.
" - } - } - } - }, - "com.amazonaws.mediatailor#VodSource": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The ARN for the VOD source.
", - "smithy.api#required": {} - } - }, - "CreationTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the VOD source was created.
" - } - }, - "HttpPackageConfigurations": { - "target": "com.amazonaws.mediatailor#HttpPackageConfigurations", - "traits": { - "smithy.api#documentation": "The HTTP package configurations for the VOD source.
", - "smithy.api#required": {} - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.mediatailor#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp that indicates when the VOD source was last modified.
" - } - }, - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the source location that the VOD source is associated with.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.mediatailor#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
", - "smithy.api#jsonName": "tags" - } - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string", - "traits": { - "smithy.api#documentation": "The name of the VOD source.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "VOD source configuration parameters.
", - "smithy.api#references": [ - { - "resource": "com.amazonaws.mediatailor#VodSourceResource" - } - ] - } - }, - "com.amazonaws.mediatailor#VodSourceResource": { - "type": "resource", - "identifiers": { - "SourceLocationName": { - "target": "com.amazonaws.mediatailor#__string" - }, - "VodSourceName": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "put": { - "target": "com.amazonaws.mediatailor#CreateVodSource" - }, - "read": { - "target": "com.amazonaws.mediatailor#DescribeVodSource" - }, - "update": { - "target": "com.amazonaws.mediatailor#UpdateVodSource" - }, - "delete": { - "target": "com.amazonaws.mediatailor#DeleteVodSource" - }, - "list": { - "target": "com.amazonaws.mediatailor#ListVodSources" - }, - "traits": { - "aws.api#arn": { - "template": "vodSource/{SourceLocationName}/{VodSourceName}" - }, - "aws.cloudformation#cfnResource": { - "name": "VodSource" - }, - "smithy.api#noReplace": {}, - "smithy.api#unstable": {} - } - }, - "com.amazonaws.mediatailor#__boolean": { - "type": "boolean" - }, - "com.amazonaws.mediatailor#__integer": { - "type": "integer" - }, - "com.amazonaws.mediatailor#__integerMin1": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.mediatailor#__integerMin1Max100": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 + "resource": "com.amazonaws.mediatailor#VodSourceResource" + } + ] + } + }, + "com.amazonaws.mediatailor#VodSourceResource": { + "type": "resource", + "identifiers": { + "SourceLocationName": { + "target": "com.amazonaws.mediatailor#__string" + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "put": { + "target": "com.amazonaws.mediatailor#CreateVodSource" + }, + "read": { + "target": "com.amazonaws.mediatailor#DescribeVodSource" + }, + "update": { + "target": "com.amazonaws.mediatailor#UpdateVodSource" + }, + "delete": { + "target": "com.amazonaws.mediatailor#DeleteVodSource" + }, + "list": { + "target": "com.amazonaws.mediatailor#ListVodSources" + }, + "traits": { + "aws.api#arn": { + "template": "vodSource/{SourceLocationName}/{VodSourceName}" + }, + "aws.cloudformation#cfnResource": { + "name": "VodSource" + }, + "smithy.api#noReplace": {}, + "smithy.api#unstable": {} + } + }, + "com.amazonaws.mediatailor#__boolean": { + "type": "boolean" + }, + "com.amazonaws.mediatailor#__integer": { + "type": "integer" + }, + "com.amazonaws.mediatailor#__integerMin1": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.mediatailor#__integerMin1Max100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.mediatailor#__listOfAdBreak": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AdBreak" + } + }, + "com.amazonaws.mediatailor#__listOfAlert": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#Alert" + } + }, + "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AvailMatchingCriteria" + } + }, + "com.amazonaws.mediatailor#__listOfChannel": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#Channel" + } + }, + "com.amazonaws.mediatailor#__listOfLiveSource": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#LiveSource" + } + }, + "com.amazonaws.mediatailor#__listOfPlaybackConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#PlaybackConfiguration" + } + }, + "com.amazonaws.mediatailor#__listOfPrefetchSchedule": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#PrefetchSchedule" + } + }, + "com.amazonaws.mediatailor#__listOfScheduleAdBreak": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#ScheduleAdBreak" + } + }, + "com.amazonaws.mediatailor#__listOfScheduleEntry": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#ScheduleEntry" + } + }, + "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#SegmentDeliveryConfiguration" + } + }, + "com.amazonaws.mediatailor#__listOfSourceLocation": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#SourceLocation" + } + }, + "com.amazonaws.mediatailor#__listOfVodSource": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#VodSource" + } + }, + "com.amazonaws.mediatailor#__listOf__string": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "com.amazonaws.mediatailor#__long": { + "type": "long" + }, + "com.amazonaws.mediatailor#__mapOf__string": { + "type": "map", + "key": { + "target": "com.amazonaws.mediatailor#__string" + }, + "value": { + "target": "com.amazonaws.mediatailor#__string" + } + }, + "com.amazonaws.mediatailor#__string": { + "type": "string" + }, + "com.amazonaws.mediatailor#__timestampUnix": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "epoch-seconds" + } + }, + "com.amazonaws.mediatailor#adMarkupTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AdMarkupType" + } } - } - }, - "com.amazonaws.mediatailor#__listOfAdBreak": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#AdBreak" - } - }, - "com.amazonaws.mediatailor#__listOfAlert": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#Alert" - } - }, - "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#AvailMatchingCriteria" - } - }, - "com.amazonaws.mediatailor#__listOfChannel": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#Channel" - } - }, - "com.amazonaws.mediatailor#__listOfLiveSource": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#LiveSource" - } - }, - "com.amazonaws.mediatailor#__listOfPlaybackConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#PlaybackConfiguration" - } - }, - "com.amazonaws.mediatailor#__listOfPrefetchSchedule": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#PrefetchSchedule" - } - }, - "com.amazonaws.mediatailor#__listOfScheduleAdBreak": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#ScheduleAdBreak" - } - }, - "com.amazonaws.mediatailor#__listOfScheduleEntry": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#ScheduleEntry" - } - }, - "com.amazonaws.mediatailor#__listOfSegmentDeliveryConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#SegmentDeliveryConfiguration" - } - }, - "com.amazonaws.mediatailor#__listOfSourceLocation": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#SourceLocation" - } - }, - "com.amazonaws.mediatailor#__listOfVodSource": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#VodSource" - } - }, - "com.amazonaws.mediatailor#__listOf__string": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "com.amazonaws.mediatailor#__long": { - "type": "long" - }, - "com.amazonaws.mediatailor#__mapOf__string": { - "type": "map", - "key": { - "target": "com.amazonaws.mediatailor#__string" - }, - "value": { - "target": "com.amazonaws.mediatailor#__string" - } - }, - "com.amazonaws.mediatailor#__string": { - "type": "string" - }, - "com.amazonaws.mediatailor#__timestampUnix": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "epoch-seconds" - } - }, - "com.amazonaws.mediatailor#adMarkupTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.mediatailor#AdMarkupType" - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/route-53.json b/codegen/sdk-codegen/aws-models/route-53.json index 4bca77d56df86..abbed34166d16 100644 --- a/codegen/sdk-codegen/aws-models/route-53.json +++ b/codegen/sdk-codegen/aws-models/route-53.json @@ -1,11806 +1,11859 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.route53#ARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.route53#AWSAccountID": { - "type": "string" - }, - "com.amazonaws.route53#AWSDnsV20130401": { - "type": "service", - "version": "2013-04-01", - "operations": [ - { - "target": "com.amazonaws.route53#ActivateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#AssociateVPCWithHostedZone" - }, - { - "target": "com.amazonaws.route53#ChangeCidrCollection" - }, - { - "target": "com.amazonaws.route53#ChangeResourceRecordSets" - }, - { - "target": "com.amazonaws.route53#ChangeTagsForResource" - }, - { - "target": "com.amazonaws.route53#CreateCidrCollection" - }, - { - "target": "com.amazonaws.route53#CreateHealthCheck" - }, - { - "target": "com.amazonaws.route53#CreateHostedZone" - }, - { - "target": "com.amazonaws.route53#CreateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#CreateQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#CreateReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#CreateTrafficPolicyVersion" - }, - { - "target": "com.amazonaws.route53#CreateVPCAssociationAuthorization" - }, - { - "target": "com.amazonaws.route53#DeactivateKeySigningKey" - }, - { - "target": "com.amazonaws.route53#DeleteCidrCollection" - }, - { - "target": "com.amazonaws.route53#DeleteHealthCheck" - }, - { - "target": "com.amazonaws.route53#DeleteHostedZone" - }, - { - "target": "com.amazonaws.route53#DeleteKeySigningKey" - }, - { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#DeleteReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#DeleteTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#DeleteTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorization" - }, - { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSEC" - }, - { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZone" - }, - { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSEC" - }, - { - "target": "com.amazonaws.route53#GetAccountLimit" - }, - { - "target": "com.amazonaws.route53#GetChange" - }, - { - "target": "com.amazonaws.route53#GetCheckerIpRanges" - }, - { - "target": "com.amazonaws.route53#GetDNSSEC" - }, - { - "target": "com.amazonaws.route53#GetGeoLocation" - }, - { - "target": "com.amazonaws.route53#GetHealthCheck" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckCount" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckLastFailureReason" - }, - { - "target": "com.amazonaws.route53#GetHealthCheckStatus" - }, - { - "target": "com.amazonaws.route53#GetHostedZone" - }, - { - "target": "com.amazonaws.route53#GetHostedZoneCount" - }, - { - "target": "com.amazonaws.route53#GetHostedZoneLimit" - }, - { - "target": "com.amazonaws.route53#GetQueryLoggingConfig" - }, - { - "target": "com.amazonaws.route53#GetReusableDelegationSet" - }, - { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimit" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#GetTrafficPolicyInstanceCount" - }, - { - "target": "com.amazonaws.route53#ListCidrBlocks" - }, - { - "target": "com.amazonaws.route53#ListCidrCollections" - }, - { - "target": "com.amazonaws.route53#ListCidrLocations" - }, - { - "target": "com.amazonaws.route53#ListGeoLocations" - }, - { - "target": "com.amazonaws.route53#ListHealthChecks" - }, - { - "target": "com.amazonaws.route53#ListHostedZones" - }, - { - "target": "com.amazonaws.route53#ListHostedZonesByName" - }, - { - "target": "com.amazonaws.route53#ListHostedZonesByVPC" - }, - { - "target": "com.amazonaws.route53#ListQueryLoggingConfigs" - }, - { - "target": "com.amazonaws.route53#ListResourceRecordSets" - }, - { - "target": "com.amazonaws.route53#ListReusableDelegationSets" - }, - { - "target": "com.amazonaws.route53#ListTagsForResource" - }, - { - "target": "com.amazonaws.route53#ListTagsForResources" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicies" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstances" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZone" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy" - }, - { - "target": "com.amazonaws.route53#ListTrafficPolicyVersions" - }, - { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizations" - }, - { - "target": "com.amazonaws.route53#TestDNSAnswer" - }, - { - "target": "com.amazonaws.route53#UpdateHealthCheck" - }, - { - "target": "com.amazonaws.route53#UpdateHostedZoneComment" + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.route53#ARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "\\S" + } }, - { - "target": "com.amazonaws.route53#UpdateTrafficPolicyComment" + "com.amazonaws.route53#AWSAccountID": { + "type": "string" }, - { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstance" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Route 53", - "arnNamespace": "route53", - "cloudFormationName": "Route53", - "cloudTrailEventSource": "route53.amazonaws.com", - "docId": "route53-2013-04-01", - "endpointPrefix": "route53" - }, - "aws.auth#sigv4": { - "name": "route53" - }, - "aws.protocols#restXml": {}, - "smithy.api#documentation": "Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.
\nYou can use Route 53 to:
\nRegister domain names.
\nFor more information, see How domain registration works.
\nRoute internet traffic to the resources for your domain
\nFor more information, see How internet traffic is routed to your website or web application.
\nCheck the health of your resources.
\nFor more information, see How Route 53 checks the health of your resources.
\nAmazon Route 53 is a highly available and scalable Domain Name System (DNS) web\n\t\t\tservice.
\nYou can use Route 53 to:
\nRegister domain names.
\nFor more information, see How domain registration works.
\nRoute internet traffic to the resources for your domain
\nFor more information, see How internet traffic is routed to your website or web application.
\nCheck the health of your resources.
\nFor more information, see How Route 53 checks the health of your resources.
\nThe limit that you requested. Valid values include the following:
\n\n MAX_HEALTH_CHECKS_BY_OWNER: The maximum\n\t\t\t\t\tnumber of health checks that you can create using the current account.
\n\n MAX_HOSTED_ZONES_BY_OWNER: The maximum number\n\t\t\t\t\tof hosted zones that you can create using the current account.
\n\n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The\n\t\t\t\t\tmaximum number of reusable delegation sets that you can create using the current\n\t\t\t\t\taccount.
\n\n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum\n\t\t\t\t\tnumber of traffic policies that you can create using the current account.
\n\n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The\n\t\t\t\t\tmaximum number of traffic policy instances that you can create using the current\n\t\t\t\t\taccount. (Traffic policy instances are referred to as traffic flow policy\n\t\t\t\t\trecords in the Amazon Route 53 console.)
\nThe current value for the limit that is specified by Type.
", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "aws-global", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region aws-global with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://route53-fips.amazonaws.com" + "traits": { + "smithy.api#documentation": "A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.
" + } + }, + "com.amazonaws.route53#AccountLimitType": { + "type": "enum", + "members": { + "MAX_HEALTH_CHECKS_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HEALTH_CHECKS_BY_OWNER" + } + }, + "MAX_HOSTED_ZONES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_HOSTED_ZONES_BY_OWNER" + } + }, + "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" + } + }, + "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" + } + }, + "MAX_TRAFFIC_POLICIES_BY_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_TRAFFIC_POLICIES_BY_OWNER" + } } - }, - "params": { - "Region": "aws-global", - "UseFIPS": true, - "UseDualStack": false - } + } + }, + "com.amazonaws.route53#ActivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyRequest" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.route53#ActivateKeySigningKeyResponse" }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-east-1" - } - ] - }, - "url": "https://route53-fips.amazonaws.com" + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This\n\t\t\toperation changes the KSK status to ACTIVE.
A unique string used to identify a hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.
For the CloudWatch alarm that you want Route 53 health checkers to use to determine\n\t\t\twhether this health check is healthy, the region that the alarm was created in.
\nFor the current list of CloudWatch regions, see Amazon CloudWatch endpoints and\n\t\t\t\tquotas in the Amazon Web Services General\n\t\t\tReference.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#AlarmName", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\n\t\t\tto determine whether this health check is healthy.
\nRoute 53 supports CloudWatch alarms with the following features:
\nStandard-resolution metrics. High-resolution metrics aren't supported. For\n\t\t\t\t\t\tmore information, see High-Resolution Metrics in the Amazon CloudWatch User\n\t\t\t\t\t\t\tGuide.
\nStatistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended\n\t\t\t\t\t\tstatistics aren't supported.
\nA complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.
" + } + }, + "com.amazonaws.route53#AlarmName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.route53#AliasHealthEnabled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#AliasTarget": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "\n Alias resource records sets only: The value used depends on where\n\t\t\tyou want to route traffic:
\nSpecify the hosted zone ID for your API. You can get the applicable value\n\t\t\t\t\t\tusing the CLI command get-domain-names:
\nFor regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalHostedZoneId.
For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the\n\t\t\t\t\t\tvalue of HostedZoneId using the CLI command\n\t\t\t\t\t\t\tdescribe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a\n\t\t\t\t\t\t\tprivate zone.
\nSpecify the hosted zone ID for the region that you created the environment\n\t\t\t\t\t\tin. The environment must have a regionalized subdomain. For a list of\n\t\t\t\t\t\tregions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the\n\t\t\t\t\t\t\tAmazon Web Services General Reference.
\nSpecify the value of the hosted zone ID for the load balancer. Use the\n\t\t\t\t\t\tfollowing methods to get the hosted zone ID:
\n\n Elastic Load Balancing endpoints and quotas topic in\n\t\t\t\t\t\t\t\tthe Amazon Web Services General Reference: Use\n\t\t\t\t\t\t\t\tthe value that corresponds with the region that you created your\n\t\t\t\t\t\t\t\tload balancer in. Note that there are separate columns for\n\t\t\t\t\t\t\t\tApplication and Classic Load Balancers and for Network Load\n\t\t\t\t\t\t\t\tBalancers.
\n\n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tAmazon EC2 page, choose Load\n\t\t\t\t\t\t\t\t\tBalancers in the navigation pane, select the load\n\t\t\t\t\t\t\t\tbalancer, and get the value of the Hosted\n\t\t\t\t\t\t\t\t\tzone field on the Description tab.
\n\n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the applicable value.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.
\n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the applicable\n\t\t\t\t\t\t\t\tvalue. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
Specify the hosted zone ID for the region that you created the bucket in.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference.
\nSpecify the hosted zone ID of your hosted zone. (An alias resource record\n\t\t\t\t\t\tset can't reference a resource record set in a different hosted\n\t\t\t\t\t\tzone.)
\n\n Alias resource record sets only: The value that you specify\n\t\t\tdepends on where you want to route queries:
\nSpecify the applicable domain name for your API. You can get the\n\t\t\t\t\t\tapplicable value using the CLI command get-domain-names:
\nFor regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalDomainName.
For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionDomainName. This is the name of the\n\t\t\t\t\t\t\t\tassociated CloudFront distribution, such as\n\t\t\t\t\t\t\t\t\tda1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain\n\t\t\t\t\t\t\tname for your API, such as api.example.com.
Enter the API endpoint for the interface endpoint, such as\n\t\t\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com.\n\t\t\t\t\t\tFor edge-optimized APIs, this is the domain name for the corresponding\n\t\t\t\t\t\tCloudFront distribution. You can get the value of DnsName using\n\t\t\t\t\t\tthe CLI command describe-vpc-endpoints.
Specify the domain name that CloudFront assigned when you created your\n\t\t\t\t\t\tdistribution.
\nYour CloudFront distribution must include an alternate domain name that\n\t\t\t\t\t\tmatches the name of the resource record set. For example, if the name of the\n\t\t\t\t\t\tresource record set is acme.example.com, your\n\t\t\t\t\t\tCloudFront distribution must include acme.example.com\n\t\t\t\t\t\tas one of the alternate domain names. For more information, see Using Alternate\n\t\t\t\t\t\t\tDomain Names (CNAMEs) in the Amazon CloudFront\n\t\t\t\t\t\t\tDeveloper Guide.
\nYou can't create a resource record set in a private hosted zone to route\n\t\t\t\t\t\ttraffic to a CloudFront distribution.
\nFor failover alias records, you can't specify a CloudFront\n\t\t\t\t\t\t\tdistribution for both the primary and secondary records. A distribution\n\t\t\t\t\t\t\tmust include an alternate domain name that matches the name of the\n\t\t\t\t\t\t\trecord. However, the primary and secondary records have the same name,\n\t\t\t\t\t\t\tand you can't include the same alternate domain name in more than one\n\t\t\t\t\t\t\tdistribution.
\nIf the domain name for your Elastic Beanstalk environment includes the\n\t\t\t\t\t\tregion that you deployed the environment in, you can create an alias record\n\t\t\t\t\t\tthat routes traffic to the environment. For example, the domain name\n\t\t\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com\n\t\t\t\t\t\tis a regionalized domain name.
For environments that were created before early 2016, the domain name\n\t\t\t\t\t\t\tdoesn't include the region. To route traffic to these environments, you\n\t\t\t\t\t\t\tmust create a CNAME record instead of an alias record. Note that you\n\t\t\t\t\t\t\tcan't create a CNAME record for the root domain name. For example, if\n\t\t\t\t\t\t\tyour domain name is example.com, you can create a record that routes\n\t\t\t\t\t\t\ttraffic for acme.example.com to your Elastic Beanstalk environment, but\n\t\t\t\t\t\t\tyou can't create a record that routes traffic for example.com to your\n\t\t\t\t\t\t\tElastic Beanstalk environment.
\nFor Elastic Beanstalk environments that have regionalized subdomains,\n\t\t\t\t\t\tspecify the CNAME attribute for the environment. You can use\n\t\t\t\t\t\tthe following methods to get the value of the CNAME attribute:
\n Amazon Web Services Management Console: For information about\n\t\t\t\t\t\t\t\thow to get the value by using the console, see Using Custom\n\t\t\t\t\t\t\t\t\tDomains with Elastic Beanstalk in the\n\t\t\t\t\t\t\t\t\t\tElastic Beanstalk Developer\n\t\t\t\t\t\t\t\tGuide.
\n\n Elastic Beanstalk API: Use the\n\t\t\t\t\t\t\t\t\tDescribeEnvironments action to get the value of the\n\t\t\t\t\t\t\t\t\tCNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.
\n CLI: Use the\n\t\t\t\t\t\t\t\t\tdescribe-environments command to get the value of\n\t\t\t\t\t\t\t\tthe CNAME attribute. For more information, see describe-environments in the CLI Command Reference.
Specify the DNS name that is associated with the load balancer. Get the\n\t\t\t\t\t\tDNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.
\n\n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tEC2 page, choose Load Balancers in\n\t\t\t\t\t\t\t\tthe navigation pane, choose the load balancer, choose the Description tab, and get the value of the\n\t\t\t\t\t\t\t\t\tDNS name field.
\nIf you're routing traffic to a Classic Load Balancer, get the\n\t\t\t\t\t\t\t\tvalue that begins with dualstack.\n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the\n\t\t\t\t\t\t\t\tvalue that applies to the record type, A or AAAA.
\n\n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:
Classic Load Balancers: DescribeLoadBalancers\n
\nApplication and Network Load Balancers: DescribeLoadBalancers\n
\n\n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:
Classic Load Balancers: describe-load-balancers\n
\nApplication and Network Load Balancers: describe-load-balancers\n
\nSpecify the DNS name for your accelerator:
\n\n Global Accelerator API: To get\n\t\t\t\t\t\t\t\tthe DNS name, use DescribeAccelerator.
\n\n CLI: To get the\n\t\t\t\t\t\t\t\tDNS name, use describe-accelerator.
\nSpecify the domain name of the Amazon S3 website endpoint that you created\n\t\t\t\t\t\tthe bucket in, for example, s3-website.us-east-2.amazonaws.com.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference. For more information about using S3 buckets for\n\t\t\t\t\t\twebsites, see Getting Started\n\t\t\t\t\t\t\twith Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.\n
Specify the value of the Name element for a resource record\n\t\t\t\t\t\tset in the current hosted zone.
If you're creating an alias record that has the same name as the\n\t\t\t\t\t\t\thosted zone (known as the zone apex), you can't specify the domain name\n\t\t\t\t\t\t\tfor a record for which the value of Type is\n\t\t\t\t\t\t\t\tCNAME. This is because the alias record must have the\n\t\t\t\t\t\t\tsame type as the record that you're routing traffic to, and creating a\n\t\t\t\t\t\t\tCNAME record for the zone apex isn't supported even for an alias\n\t\t\t\t\t\t\trecord.
\n Applies only to alias, failover alias, geolocation alias, latency alias, and\n\t\t\t\tweighted alias resource record sets: When\n\t\t\t\tEvaluateTargetHealth is true, an alias resource record set\n\t\t\tinherits the health of the referenced Amazon Web Services resource, such as an ELB load\n\t\t\tbalancer or another resource record set in the hosted zone.
Note the following:
\nYou can't set EvaluateTargetHealth to true when\n\t\t\t\t\t\tthe alias target is a CloudFront distribution.
If you specify an Elastic Beanstalk environment in DNSName\n\t\t\t\t\t\tand the environment contains an ELB load balancer, Elastic Load Balancing\n\t\t\t\t\t\troutes queries only to the healthy Amazon EC2 instances that are registered\n\t\t\t\t\t\twith the load balancer. (An environment automatically contains an ELB load\n\t\t\t\t\t\tbalancer if it includes more than one Amazon EC2 instance.) If you set\n\t\t\t\t\t\t\tEvaluateTargetHealth to true and either no\n\t\t\t\t\t\tAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\n\t\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if\n\t\t\t\t\t\tany.
If the environment contains a single Amazon EC2 instance, there are no\n\t\t\t\t\t\tspecial requirements.
\nHealth checking behavior depends on the type of load balancer:
\n\n Classic Load Balancers: If you\n\t\t\t\t\t\t\t\tspecify an ELB Classic Load Balancer in DNSName,\n\t\t\t\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2\n\t\t\t\t\t\t\t\tinstances that are registered with the load balancer. If you set\n\t\t\t\t\t\t\t\t\tEvaluateTargetHealth to true and\n\t\t\t\t\t\t\t\teither no EC2 instances are healthy or the load balancer itself is\n\t\t\t\t\t\t\t\tunhealthy, Route 53 routes queries to other resources.
\n Application and Network Load\n\t\t\t\t\t\t\t\t\tBalancers: If you specify an ELB Application or\n\t\t\t\t\t\t\t\tNetwork Load Balancer and you set EvaluateTargetHealth\n\t\t\t\t\t\t\t\tto true, Route 53 routes queries to the load balancer\n\t\t\t\t\t\t\t\tbased on the health of the target groups that are associated with\n\t\t\t\t\t\t\t\tthe load balancer:
For an Application or Network Load Balancer to be\n\t\t\t\t\t\t\t\t\t\tconsidered healthy, every target group that contains targets\n\t\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target\n\t\t\t\t\t\t\t\t\t\tgroup contains only unhealthy targets, the load balancer is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy, and Route 53 routes queries to other\n\t\t\t\t\t\t\t\t\t\tresources.
\nA target group that has no registered targets is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy.
\nWhen you create a load balancer, you configure settings for Elastic\n\t\t\t\t\t\t\tLoad Balancing health checks; they're not Route 53 health checks, but\n\t\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks\n\t\t\t\t\t\t\tfor the EC2 instances that you register with an ELB load balancer.\n\t\t\t\t\t\t
\nThere are no special requirements for setting\n\t\t\t\t\t\t\tEvaluateTargetHealth to true when the alias\n\t\t\t\t\t\ttarget is an S3 bucket.
If the Amazon Web Services resource that you specify in\n\t\t\t\t\t\t\tDNSName is a record or a group of records (for example, a\n\t\t\t\t\t\tgroup of weighted records) but is not another alias record, we recommend\n\t\t\t\t\t\tthat you associate a health check with all of the records in the alias\n\t\t\t\t\t\ttarget. For more information, see What Happens When You Omit Health Checks? in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks\n\t\t\t\tand DNS Failover in the Amazon Route 53 Developer\n\t\t\tGuide.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.
\nWhen creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:
\nFor information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see Configuring Failover in a Private Hosted Zone.
\nAssociates an Amazon VPC with a private hosted zone.
\nTo perform the association, the VPC and the private hosted zone must already\n\t\t\t\texist. You can't convert a public hosted zone into a private hosted zone.
\nIf you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a\n\t\t\t\tdifferent account, the Amazon Web Services account that created the private hosted\n\t\t\t\tzone must first submit a CreateVPCAssociationAuthorization request.\n\t\t\t\tThen the account that created the VPC must submit an\n\t\t\t\t\tAssociateVPCWithHostedZone request.
When granting access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe ID of the private hosted zone that you want to associate an Amazon VPC\n\t\t\twith.
\nNote that you can't associate a VPC with a hosted zone that doesn't have an existing\n\t\t\tVPC association.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the VPC that you want to associate with\n\t\t\ta private hosted zone.
", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#AssociateVPCComment", + "traits": { + "smithy.api#documentation": "\n Optional: A comment about the association request.
" + } } - }, - "params": { - "Region": "aws-us-gov-global", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region aws-us-gov-global with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" + "traits": { + "smithy.api#documentation": "A complex type that contains information about the request to associate a VPC with a\n\t\t\tprivate hosted zone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "A complex type that describes the changes made to your hosted zone.
", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "aws-us-gov-global", - "UseFIPS": true, - "UseDualStack": false - } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tAssociateVPCWithHostedZone request.
The action to perform:
\n\n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.
\n DELETE: Deletes a existing resource record set.
To delete the resource record set that is associated with a traffic policy\n\t\t\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the\n\t\t\t\t\t\tresource record set automatically. If you delete the resource record set by\n\t\t\t\t\t\tusing ChangeResourceRecordSets, Route 53 doesn't automatically\n\t\t\t\t\t\tdelete the traffic policy instance, and you'll continue to be charged for it\n\t\t\t\t\t\teven though it's no longer in use.
\n UPSERT: If a resource record set doesn't already exist, Route 53\n\t\t\t\t\tcreates it. If a resource record set does exist, Route 53 updates it with the\n\t\t\t\t\tvalues in the request.
Information about the resource record set to create, delete, or update.
", + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" + "traits": { + "smithy.api#documentation": "The information for each resource record set that you want to change.
" + } + }, + "com.amazonaws.route53#ChangeAction": { + "type": "enum", + "members": { + "CREATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "UPSERT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPSERT" + } + } + } + }, + "com.amazonaws.route53#ChangeBatch": { + "type": "structure", + "members": { + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "\n Optional: Any comments you want to include about a change batch\n\t\t\trequest.
" + } + }, + "Changes": { + "target": "com.amazonaws.route53#Changes", + "traits": { + "smithy.api#documentation": "Information about the changes to make to the record sets.
", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://route53.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "The information for a change request.
" + } + }, + "com.amazonaws.route53#ChangeCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeCidrCollectionRequest" }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-gov-west-1" - } - ] - }, - "url": "https://route53.us-gov.amazonaws.com" + "output": { + "target": "com.amazonaws.route53#ChangeCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrBlockInUseException" + }, + { + "target": "com.amazonaws.route53#CidrCollectionVersionMismatchException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.
\nA change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime.
\n\n Limits\n
\nThe max number of CIDR blocks included in the request is 1000. As a result, big updates\n\t\t\trequire multiple API calls.
\n\n PUT and DELETE_IF_EXISTS\n
\nUse ChangeCidrCollection to perform the following actions:
\n PUT: Create a CIDR block within the specified collection.
\n DELETE_IF_EXISTS: Delete an existing CIDR block from the\n\t\t\t\t\tcollection.
The UUID of the CIDR collection to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "CollectionVersion": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\tcollection and increments it by 1 each time you update the collection.
\nWe recommend that you use ListCidrCollection to get the current value of\n\t\t\t\tCollectionVersion for the collection that you want to update, and then\n\t\t\tinclude that value with the change request. This prevents Route 53 from\n\t\t\toverwriting an intervening update:
If the value in the request matches the value of\n\t\t\t\t\t\tCollectionVersion in the collection, Route 53 updates\n\t\t\t\t\tthe collection.
If the value of CollectionVersion in the collection is greater\n\t\t\t\t\tthan the value in the request, the collection was changed after you got the\n\t\t\t\t\tversion number. Route 53 does not update the collection, and it\n\t\t\t\t\treturns a CidrCollectionVersionMismatch error.
Information about changes to a CIDR collection.
", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region aws-iso-global with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://route53.c2s.ic.gov" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ChangeCidrCollectionResponse": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ChangeId", + "traits": { + "smithy.api#documentation": "The ID that is returned by ChangeCidrCollection. You can use it as input to\n\t\t\t\tGetChange to see if a CIDR collection change has propagated or\n\t\t\tnot.
This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.route53#ChangeStatus", + "traits": { + "smithy.api#documentation": "The current state of the request. PENDING indicates that this request has\n\t\t\tnot yet been applied to all Amazon Route 53 DNS servers.
The date and time that the change request was submitted in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.
A comment you can provide.
" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "A complex type that describes change information about changes made to your hosted\n\t\t\tzone.
" + } + }, + "com.amazonaws.route53#ChangeResourceRecordSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeResourceRecordSetsRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "output": { + "target": "com.amazonaws.route53#ChangeResourceRecordSetsResponse" }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-iso-east-1" - } - ] - }, - "url": "https://route53.c2s.ic.gov" + "errors": [ + { + "target": "com.amazonaws.route53#InvalidChangeBatch" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.
\n Deleting Resource Record Sets\n
\nTo delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.
\n\n Change Batches and Transactional Changes\n
\nThe request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.
For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.
If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.
\n Traffic Flow\n
\nTo create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.
\n\n Create, Delete, and Upsert\n
\nUse ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:
\n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.
\n DELETE: Deletes an existing resource record set that has the\n\t\t\t\t\tspecified values.
\n UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource\n\t\t\t\t\tset exists Route 53 updates it with the values in the request.
\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n
\nThe syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.
\nFor an example for each type of resource record set, see \"Examples.\"
\nDon't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.
\n Change Propagation to Route 53 DNS Servers\n
\nWhen you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.
\n Limits on ChangeResourceRecordSets Requests\n
\nFor information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.
The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tchange.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChangeBatch": { + "target": "com.amazonaws.route53#ChangeBatch", + "traits": { + "smithy.api#documentation": "A complex type that contains an optional comment and the Changes\n\t\t\telement.
A complex type that contains change information for the resource record set.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ChangeResourceRecordSetsResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "A complex type that contains information about changes made to your hosted\n\t\t\tzone.
\nThis element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.
", + "smithy.api#required": {} + } } - }, - "params": { - "Region": "aws-iso-b-global", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "A complex type containing the response for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ChangeStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "INSYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSYNC" + } + } + } + }, + "com.amazonaws.route53#ChangeTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ChangeTagsForResourceRequest" }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://route53-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.route53#ChangeTagsForResourceResponse" }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Adds, edits, or deletes tags for a health check or a hosted zone.
\nFor information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.
", + "smithy.api#examples": [ + { + "title": "To add or remove tags from a hosted zone or health check", + "documentation": "The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE.", + "input": { + "ResourceType": "hostedzone", + "ResourceId": "Z3M3LMPEXAMPLE", + "AddTags": [ + { + "Key": "apex", + "Value": "3874" + }, + { + "Key": "acme", + "Value": "4938" + } + ], + "RemoveTagKeys": [ + "Nadir" + ] + }, + "output": {} + } + ], + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ChangeTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
The ID of the resource for which you want to add, change, or delete tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AddTags": { + "target": "com.amazonaws.route53#TagList", + "traits": { + "smithy.api#documentation": "A complex type that contains a list of the tags that you want to add to the specified\n\t\t\thealth check or hosted zone and/or the tags that you want to edit Value\n\t\t\tfor.
You can add a maximum of 10 tags to a health check or a hosted zone.
" + } + }, + "RemoveTagKeys": { + "target": "com.amazonaws.route53#TagKeyList", + "traits": { + "smithy.api#documentation": "A complex type that contains a list of the tags that you want to delete from the\n\t\t\tspecified health check or hosted zone. You can specify up to 10 keys.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "properties": { - "authSchemes": [ - { - "name": "sigv4", - "signingName": "route53", - "signingRegion": "us-isob-east-1" - } - ] - }, - "url": "https://route53.sc2s.sgov.gov" + "traits": { + "smithy.api#documentation": "A complex type that contains information about the tags that you want to add, edit, or\n\t\t\tdelete.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ChangeTagsForResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Empty response for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#Changes": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Change", + "traits": { + "smithy.api#xmlName": "Change" } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.route53#CheckerIpRanges": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#IPAddressCidr" + } + }, + "com.amazonaws.route53#ChildHealthCheckList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#xmlName": "ChildHealthCheck" + } }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#Cidr": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.route53#CidrBlockInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "This CIDR block is already in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#CidrBlockSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrBlockSummary" + } + }, + "com.amazonaws.route53#CidrBlockSummary": { + "type": "structure", + "members": { + "CidrBlock": { + "target": "com.amazonaws.route53#Cidr", + "traits": { + "smithy.api#documentation": "Value for the CIDR block.
" + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "The location name of the CIDR block.
" + } + } }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } + "traits": { + "smithy.api#documentation": "A complex type that lists the CIDR blocks.
" + } + }, + "com.amazonaws.route53#CidrCollection": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the collection. Can be used to reference the collection in IAM policy or in\n\t\t\tanother Amazon Web Services account.
" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "The unique ID of the CIDR collection.
" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "The name of a CIDR collection.
" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.
" + } + } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "traits": { + "smithy.api#documentation": "A complex\n\t\t\ttype that\n\t\t\tidentifies a CIDR collection.
" + } + }, + "com.amazonaws.route53#CidrCollectionAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } }, - { - "documentation": "Partition doesn't support DualStack", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.route53#AccountLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#AccountLimitType", - "traits": { - "smithy.api#documentation": "The limit that you requested. Valid values include the following:
\n\n MAX_HEALTH_CHECKS_BY_OWNER: The maximum\n\t\t\t\t\tnumber of health checks that you can create using the current account.
\n\n MAX_HOSTED_ZONES_BY_OWNER: The maximum number\n\t\t\t\t\tof hosted zones that you can create using the current account.
\n\n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The\n\t\t\t\t\tmaximum number of reusable delegation sets that you can create using the current\n\t\t\t\t\taccount.
\n\n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum\n\t\t\t\t\tnumber of traffic policies that you can create using the current account.
\n\n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The\n\t\t\t\t\tmaximum number of traffic policy instances that you can create using the current\n\t\t\t\t\taccount. (Traffic policy instances are referred to as traffic flow policy\n\t\t\t\t\trecords in the Amazon Route 53 console.)
\nThe current value for the limit that is specified by Type.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.
" - } - }, - "com.amazonaws.route53#AccountLimitType": { - "type": "enum", - "members": { - "MAX_HEALTH_CHECKS_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_HEALTH_CHECKS_BY_OWNER" - } - }, - "MAX_HOSTED_ZONES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_HOSTED_ZONES_BY_OWNER" - } - }, - "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER" - } - }, - "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER" - } - }, - "MAX_TRAFFIC_POLICIES_BY_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_TRAFFIC_POLICIES_BY_OWNER" - } - } - } - }, - "com.amazonaws.route53#ActivateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ActivateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#ActivateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This\n\t\t\toperation changes the KSK status to ACTIVE.
A unique string used to identify a hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.
For the CloudWatch alarm that you want Route 53 health checkers to use to determine\n\t\t\twhether this health check is healthy, the region that the alarm was created in.
\nFor the current list of CloudWatch regions, see Amazon CloudWatch endpoints and\n\t\t\t\tquotas in the Amazon Web Services General\n\t\t\tReference.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#AlarmName", - "traits": { - "smithy.api#documentation": "The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use\n\t\t\tto determine whether this health check is healthy.
\nRoute 53 supports CloudWatch alarms with the following features:
\nStandard-resolution metrics. High-resolution metrics aren't supported. For\n\t\t\t\t\t\tmore information, see High-Resolution Metrics in the Amazon CloudWatch User\n\t\t\t\t\t\t\tGuide.
\nStatistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended\n\t\t\t\t\t\tstatistics aren't supported.
\nA complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.
" - } - }, - "com.amazonaws.route53#AlarmName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.route53#AliasHealthEnabled": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#AliasTarget": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "\n Alias resource records sets only: The value used depends on where\n\t\t\tyou want to route traffic:
\nSpecify the hosted zone ID for your API. You can get the applicable value\n\t\t\t\t\t\tusing the CLI command get-domain-names:
\nFor regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalHostedZoneId.
For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionHostedZoneId.
Specify the hosted zone ID for your interface endpoint. You can get the\n\t\t\t\t\t\tvalue of HostedZoneId using the CLI command\n\t\t\t\t\t\t\tdescribe-vpc-endpoints.
Specify Z2FDTNDATAQYW2.
Alias resource record sets for CloudFront can't be created in a\n\t\t\t\t\t\t\tprivate zone.
\nSpecify the hosted zone ID for the region that you created the environment\n\t\t\t\t\t\tin. The environment must have a regionalized subdomain. For a list of\n\t\t\t\t\t\tregions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the\n\t\t\t\t\t\t\tAmazon Web Services General Reference.
\nSpecify the value of the hosted zone ID for the load balancer. Use the\n\t\t\t\t\t\tfollowing methods to get the hosted zone ID:
\n\n Elastic Load Balancing endpoints and quotas topic in\n\t\t\t\t\t\t\t\tthe Amazon Web Services General Reference: Use\n\t\t\t\t\t\t\t\tthe value that corresponds with the region that you created your\n\t\t\t\t\t\t\t\tload balancer in. Note that there are separate columns for\n\t\t\t\t\t\t\t\tApplication and Classic Load Balancers and for Network Load\n\t\t\t\t\t\t\t\tBalancers.
\n\n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tAmazon EC2 page, choose Load\n\t\t\t\t\t\t\t\t\tBalancers in the navigation pane, select the load\n\t\t\t\t\t\t\t\tbalancer, and get the value of the Hosted\n\t\t\t\t\t\t\t\t\tzone field on the Description tab.
\n\n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the applicable value.\n\t\t\t\t\t\t\t\tFor more information, see the applicable guide:
Classic Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.
Application and Network Load Balancers: Use DescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.
\n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the applicable\n\t\t\t\t\t\t\t\tvalue. For more information, see the applicable guide:
Classic Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneNameId.
Application and Network Load Balancers: Use describe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\t\t\tCanonicalHostedZoneId.
Specify Z2BJ6XQ5FK7U4H.
Specify the hosted zone ID for the region that you created the bucket in.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference.
\nSpecify the hosted zone ID of your hosted zone. (An alias resource record\n\t\t\t\t\t\tset can't reference a resource record set in a different hosted\n\t\t\t\t\t\tzone.)
\n\n Alias resource record sets only: The value that you specify\n\t\t\tdepends on where you want to route queries:
\nSpecify the applicable domain name for your API. You can get the\n\t\t\t\t\t\tapplicable value using the CLI command get-domain-names:
\nFor regional APIs, specify the value of\n\t\t\t\t\t\t\t\t\tregionalDomainName.
For edge-optimized APIs, specify the value of\n\t\t\t\t\t\t\t\t\tdistributionDomainName. This is the name of the\n\t\t\t\t\t\t\t\tassociated CloudFront distribution, such as\n\t\t\t\t\t\t\t\t\tda1b2c3d4e5.cloudfront.net.
The name of the record that you're creating must match a custom domain\n\t\t\t\t\t\t\tname for your API, such as api.example.com.
Enter the API endpoint for the interface endpoint, such as\n\t\t\t\t\t\t\tvpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com.\n\t\t\t\t\t\tFor edge-optimized APIs, this is the domain name for the corresponding\n\t\t\t\t\t\tCloudFront distribution. You can get the value of DnsName using\n\t\t\t\t\t\tthe CLI command describe-vpc-endpoints.
Specify the domain name that CloudFront assigned when you created your\n\t\t\t\t\t\tdistribution.
\nYour CloudFront distribution must include an alternate domain name that\n\t\t\t\t\t\tmatches the name of the resource record set. For example, if the name of the\n\t\t\t\t\t\tresource record set is acme.example.com, your\n\t\t\t\t\t\tCloudFront distribution must include acme.example.com\n\t\t\t\t\t\tas one of the alternate domain names. For more information, see Using Alternate\n\t\t\t\t\t\t\tDomain Names (CNAMEs) in the Amazon CloudFront\n\t\t\t\t\t\t\tDeveloper Guide.
\nYou can't create a resource record set in a private hosted zone to route\n\t\t\t\t\t\ttraffic to a CloudFront distribution.
\nFor failover alias records, you can't specify a CloudFront\n\t\t\t\t\t\t\tdistribution for both the primary and secondary records. A distribution\n\t\t\t\t\t\t\tmust include an alternate domain name that matches the name of the\n\t\t\t\t\t\t\trecord. However, the primary and secondary records have the same name,\n\t\t\t\t\t\t\tand you can't include the same alternate domain name in more than one\n\t\t\t\t\t\t\tdistribution.
\nIf the domain name for your Elastic Beanstalk environment includes the\n\t\t\t\t\t\tregion that you deployed the environment in, you can create an alias record\n\t\t\t\t\t\tthat routes traffic to the environment. For example, the domain name\n\t\t\t\t\t\t\t\tmy-environment.us-west-2.elasticbeanstalk.com\n\t\t\t\t\t\tis a regionalized domain name.
For environments that were created before early 2016, the domain name\n\t\t\t\t\t\t\tdoesn't include the region. To route traffic to these environments, you\n\t\t\t\t\t\t\tmust create a CNAME record instead of an alias record. Note that you\n\t\t\t\t\t\t\tcan't create a CNAME record for the root domain name. For example, if\n\t\t\t\t\t\t\tyour domain name is example.com, you can create a record that routes\n\t\t\t\t\t\t\ttraffic for acme.example.com to your Elastic Beanstalk environment, but\n\t\t\t\t\t\t\tyou can't create a record that routes traffic for example.com to your\n\t\t\t\t\t\t\tElastic Beanstalk environment.
\nFor Elastic Beanstalk environments that have regionalized subdomains,\n\t\t\t\t\t\tspecify the CNAME attribute for the environment. You can use\n\t\t\t\t\t\tthe following methods to get the value of the CNAME attribute:
\n Amazon Web Services Management Console: For information about\n\t\t\t\t\t\t\t\thow to get the value by using the console, see Using Custom\n\t\t\t\t\t\t\t\t\tDomains with Elastic Beanstalk in the\n\t\t\t\t\t\t\t\t\t\tElastic Beanstalk Developer\n\t\t\t\t\t\t\t\tGuide.
\n\n Elastic Beanstalk API: Use the\n\t\t\t\t\t\t\t\t\tDescribeEnvironments action to get the value of the\n\t\t\t\t\t\t\t\t\tCNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.
\n CLI: Use the\n\t\t\t\t\t\t\t\t\tdescribe-environments command to get the value of\n\t\t\t\t\t\t\t\tthe CNAME attribute. For more information, see describe-environments in the CLI Command Reference.
Specify the DNS name that is associated with the load balancer. Get the\n\t\t\t\t\t\tDNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.
\n\n Amazon Web Services Management Console: Go to the\n\t\t\t\t\t\t\t\tEC2 page, choose Load Balancers in\n\t\t\t\t\t\t\t\tthe navigation pane, choose the load balancer, choose the Description tab, and get the value of the\n\t\t\t\t\t\t\t\t\tDNS name field.
\nIf you're routing traffic to a Classic Load Balancer, get the\n\t\t\t\t\t\t\t\tvalue that begins with dualstack.\n\t\t\t\t\t\t\t\tIf you're routing traffic to another type of load balancer, get the\n\t\t\t\t\t\t\t\tvalue that applies to the record type, A or AAAA.
\n\n Elastic Load Balancing API: Use\n\t\t\t\t\t\t\t\t\tDescribeLoadBalancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:
Classic Load Balancers: DescribeLoadBalancers\n
\nApplication and Network Load Balancers: DescribeLoadBalancers\n
\n\n CLI: Use\n\t\t\t\t\t\t\t\t\tdescribe-load-balancers to get the value of\n\t\t\t\t\t\t\t\t\tDNSName. For more information, see the applicable\n\t\t\t\t\t\t\t\tguide:
Classic Load Balancers: describe-load-balancers\n
\nApplication and Network Load Balancers: describe-load-balancers\n
\nSpecify the DNS name for your accelerator:
\n\n Global Accelerator API: To get\n\t\t\t\t\t\t\t\tthe DNS name, use DescribeAccelerator.
\n\n CLI: To get the\n\t\t\t\t\t\t\t\tDNS name, use describe-accelerator.
\nSpecify the domain name of the Amazon S3 website endpoint that you created\n\t\t\t\t\t\tthe bucket in, for example, s3-website.us-east-2.amazonaws.com.\n\t\t\t\t\t\tFor more information about valid values, see the table Amazon S3\n\t\t\t\t\t\t\tWebsite Endpoints in the Amazon Web Services General\n\t\t\t\t\t\t\tReference. For more information about using S3 buckets for\n\t\t\t\t\t\twebsites, see Getting Started\n\t\t\t\t\t\t\twith Amazon Route 53 in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.\n
Specify the value of the Name element for a resource record\n\t\t\t\t\t\tset in the current hosted zone.
If you're creating an alias record that has the same name as the\n\t\t\t\t\t\t\thosted zone (known as the zone apex), you can't specify the domain name\n\t\t\t\t\t\t\tfor a record for which the value of Type is\n\t\t\t\t\t\t\t\tCNAME. This is because the alias record must have the\n\t\t\t\t\t\t\tsame type as the record that you're routing traffic to, and creating a\n\t\t\t\t\t\t\tCNAME record for the zone apex isn't supported even for an alias\n\t\t\t\t\t\t\trecord.
\n Applies only to alias, failover alias, geolocation alias, latency alias, and\n\t\t\t\tweighted alias resource record sets: When\n\t\t\t\tEvaluateTargetHealth is true, an alias resource record set\n\t\t\tinherits the health of the referenced Amazon Web Services resource, such as an ELB load\n\t\t\tbalancer or another resource record set in the hosted zone.
Note the following:
\nYou can't set EvaluateTargetHealth to true when\n\t\t\t\t\t\tthe alias target is a CloudFront distribution.
If you specify an Elastic Beanstalk environment in DNSName\n\t\t\t\t\t\tand the environment contains an ELB load balancer, Elastic Load Balancing\n\t\t\t\t\t\troutes queries only to the healthy Amazon EC2 instances that are registered\n\t\t\t\t\t\twith the load balancer. (An environment automatically contains an ELB load\n\t\t\t\t\t\tbalancer if it includes more than one Amazon EC2 instance.) If you set\n\t\t\t\t\t\t\tEvaluateTargetHealth to true and either no\n\t\t\t\t\t\tAmazon EC2 instances are healthy or the load balancer itself is unhealthy,\n\t\t\t\t\t\tRoute 53 routes queries to other available resources that are healthy, if\n\t\t\t\t\t\tany.
If the environment contains a single Amazon EC2 instance, there are no\n\t\t\t\t\t\tspecial requirements.
\nHealth checking behavior depends on the type of load balancer:
\n\n Classic Load Balancers: If you\n\t\t\t\t\t\t\t\tspecify an ELB Classic Load Balancer in DNSName,\n\t\t\t\t\t\t\t\tElastic Load Balancing routes queries only to the healthy Amazon EC2\n\t\t\t\t\t\t\t\tinstances that are registered with the load balancer. If you set\n\t\t\t\t\t\t\t\t\tEvaluateTargetHealth to true and\n\t\t\t\t\t\t\t\teither no EC2 instances are healthy or the load balancer itself is\n\t\t\t\t\t\t\t\tunhealthy, Route 53 routes queries to other resources.
\n Application and Network Load\n\t\t\t\t\t\t\t\t\tBalancers: If you specify an ELB Application or\n\t\t\t\t\t\t\t\tNetwork Load Balancer and you set EvaluateTargetHealth\n\t\t\t\t\t\t\t\tto true, Route 53 routes queries to the load balancer\n\t\t\t\t\t\t\t\tbased on the health of the target groups that are associated with\n\t\t\t\t\t\t\t\tthe load balancer:
For an Application or Network Load Balancer to be\n\t\t\t\t\t\t\t\t\t\tconsidered healthy, every target group that contains targets\n\t\t\t\t\t\t\t\t\t\tmust contain at least one healthy target. If any target\n\t\t\t\t\t\t\t\t\t\tgroup contains only unhealthy targets, the load balancer is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy, and Route 53 routes queries to other\n\t\t\t\t\t\t\t\t\t\tresources.
\nA target group that has no registered targets is\n\t\t\t\t\t\t\t\t\t\tconsidered unhealthy.
\nWhen you create a load balancer, you configure settings for Elastic\n\t\t\t\t\t\t\tLoad Balancing health checks; they're not Route 53 health checks, but\n\t\t\t\t\t\t\tthey perform a similar function. Do not create Route 53 health checks\n\t\t\t\t\t\t\tfor the EC2 instances that you register with an ELB load balancer.\n\t\t\t\t\t\t
\nThere are no special requirements for setting\n\t\t\t\t\t\t\tEvaluateTargetHealth to true when the alias\n\t\t\t\t\t\ttarget is an S3 bucket.
If the Amazon Web Services resource that you specify in\n\t\t\t\t\t\t\tDNSName is a record or a group of records (for example, a\n\t\t\t\t\t\tgroup of weighted records) but is not another alias record, we recommend\n\t\t\t\t\t\tthat you associate a health check with all of the records in the alias\n\t\t\t\t\t\ttarget. For more information, see What Happens When You Omit Health Checks? in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks\n\t\t\t\tand DNS Failover in the Amazon Route 53 Developer\n\t\t\tGuide.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.
\nWhen creating resource record sets for a private hosted zone, note the\n\t\t\tfollowing:
\nFor information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see Configuring Failover in a Private Hosted Zone.
\nAssociates an Amazon VPC with a private hosted zone.
\nTo perform the association, the VPC and the private hosted zone must already\n\t\t\t\texist. You can't convert a public hosted zone into a private hosted zone.
\nIf you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a\n\t\t\t\tdifferent account, the Amazon Web Services account that created the private hosted\n\t\t\t\tzone must first submit a CreateVPCAssociationAuthorization request.\n\t\t\t\tThen the account that created the VPC must submit an\n\t\t\t\t\tAssociateVPCWithHostedZone request.
When granting access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe ID of the private hosted zone that you want to associate an Amazon VPC\n\t\t\twith.
\nNote that you can't associate a VPC with a hosted zone that doesn't have an existing\n\t\t\tVPC association.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the VPC that you want to associate with\n\t\t\ta private hosted zone.
", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#AssociateVPCComment", - "traits": { - "smithy.api#documentation": "\n Optional: A comment about the association request.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the request to associate a VPC with a\n\t\t\tprivate hosted zone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#AssociateVPCWithHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "A complex type that describes the changes made to your hosted zone.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tAssociateVPCWithHostedZone request.
The action to perform:
\n\n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.
\n DELETE: Deletes a existing resource record set.
To delete the resource record set that is associated with a traffic policy\n\t\t\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the\n\t\t\t\t\t\tresource record set automatically. If you delete the resource record set by\n\t\t\t\t\t\tusing ChangeResourceRecordSets, Route 53 doesn't automatically\n\t\t\t\t\t\tdelete the traffic policy instance, and you'll continue to be charged for it\n\t\t\t\t\t\teven though it's no longer in use.
\n UPSERT: If a resource record set doesn't already exist, Route 53\n\t\t\t\t\tcreates it. If a resource record set does exist, Route 53 updates it with the\n\t\t\t\t\tvalues in the request.
Information about the resource record set to create, delete, or update.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The information for each resource record set that you want to change.
" - } - }, - "com.amazonaws.route53#ChangeAction": { - "type": "enum", - "members": { - "CREATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - }, - "UPSERT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPSERT" - } - } - } - }, - "com.amazonaws.route53#ChangeBatch": { - "type": "structure", - "members": { - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "\n Optional: Any comments you want to include about a change batch\n\t\t\trequest.
" - } - }, - "Changes": { - "target": "com.amazonaws.route53#Changes", - "traits": { - "smithy.api#documentation": "Information about the changes to make to the record sets.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The information for a change request.
" - } - }, - "com.amazonaws.route53#ChangeCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrBlockInUseException" - }, - { - "target": "com.amazonaws.route53#CidrCollectionVersionMismatchException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative\n\t\t\tIP information mapping blocks to one or multiple locations.
\nA change request can update multiple locations in a collection at a time, which is\n\t\t\thelpful if you want to move one or more CIDR blocks from one location to another in one\n\t\t\ttransaction, without downtime.
\n\n Limits\n
\nThe max number of CIDR blocks included in the request is 1000. As a result, big updates\n\t\t\trequire multiple API calls.
\n\n PUT and DELETE_IF_EXISTS\n
\nUse ChangeCidrCollection to perform the following actions:
\n PUT: Create a CIDR block within the specified collection.
\n DELETE_IF_EXISTS: Delete an existing CIDR block from the\n\t\t\t\t\tcollection.
The UUID of the CIDR collection to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "CollectionVersion": { - "target": "com.amazonaws.route53#CollectionVersion", - "traits": { - "smithy.api#documentation": "A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\tcollection and increments it by 1 each time you update the collection.
\nWe recommend that you use ListCidrCollection to get the current value of\n\t\t\t\tCollectionVersion for the collection that you want to update, and then\n\t\t\tinclude that value with the change request. This prevents Route 53 from\n\t\t\toverwriting an intervening update:
If the value in the request matches the value of\n\t\t\t\t\t\tCollectionVersion in the collection, Route 53 updates\n\t\t\t\t\tthe collection.
If the value of CollectionVersion in the collection is greater\n\t\t\t\t\tthan the value in the request, the collection was changed after you got the\n\t\t\t\t\tversion number. Route 53 does not update the collection, and it\n\t\t\t\t\treturns a CidrCollectionVersionMismatch error.
Information about changes to a CIDR collection.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ChangeCidrCollectionResponse": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ChangeId", - "traits": { - "smithy.api#documentation": "The ID that is returned by ChangeCidrCollection. You can use it as input to\n\t\t\t\tGetChange to see if a CIDR collection change has propagated or\n\t\t\tnot.
This element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.route53#ChangeStatus", - "traits": { - "smithy.api#documentation": "The current state of the request. PENDING indicates that this request has\n\t\t\tnot yet been applied to all Amazon Route 53 DNS servers.
The date and time that the change request was submitted in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.
A comment you can provide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that describes change information about changes made to your hosted\n\t\t\tzone.
" - } - }, - "com.amazonaws.route53#ChangeResourceRecordSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeResourceRecordSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeResourceRecordSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidChangeBatch" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "Creates, changes, or deletes a resource record set, which contains authoritative DNS\n\t\t\tinformation for a specified domain name or subdomain name. For example, you can use\n\t\t\t\tChangeResourceRecordSets to create a resource record set that routes\n\t\t\ttraffic for test.example.com to a web server that has an IP address of\n\t\t\t192.0.2.44.
\n Deleting Resource Record Sets\n
\nTo delete a resource record set, you must specify all the same values that you\n\t\t\tspecified when you created it.
\n\n Change Batches and Transactional Changes\n
\nThe request body must include a document with a\n\t\t\t\tChangeResourceRecordSetsRequest element. The request body contains a\n\t\t\tlist of change items, known as a change batch. Change batches are considered\n\t\t\ttransactional changes. Route 53 validates the changes in the request and then either\n\t\t\tmakes all or none of the changes in the change batch request. This ensures that DNS\n\t\t\trouting isn't adversely affected by partial changes to the resource record sets in a\n\t\t\thosted zone.
For example, suppose a change batch request contains two changes: it deletes the\n\t\t\t\tCNAME resource record set for www.example.com and creates an alias\n\t\t\tresource record set for www.example.com. If validation for both records succeeds, Route\n\t\t\t53 deletes the first resource record set and creates the second resource record set in a\n\t\t\tsingle operation. If validation for either the DELETE or the\n\t\t\t\tCREATE action fails, then the request is canceled, and the original\n\t\t\t\tCNAME record continues to exist.
If you try to delete the same resource record set more than once in a single\n\t\t\t\tchange batch, Route 53 returns an InvalidChangeBatch error.
\n Traffic Flow\n
\nTo create resource record sets for complex routing configurations, use either the\n\t\t\ttraffic flow visual editor in the Route 53 console or the API actions for traffic\n\t\t\tpolicies and traffic policy instances. Save the configuration as a traffic policy, then\n\t\t\tassociate the traffic policy with one or more domain names (such as example.com) or\n\t\t\tsubdomain names (such as www.example.com), in the same hosted zone or in multiple hosted\n\t\t\tzones. You can roll back the updates if the new configuration isn't performing as\n\t\t\texpected. For more information, see Using Traffic Flow to Route\n\t\t\t\tDNS Traffic in the Amazon Route 53 Developer\n\t\t\tGuide.
\n\n Create, Delete, and Upsert\n
\nUse ChangeResourceRecordsSetsRequest to perform the following\n\t\t\tactions:
\n CREATE: Creates a resource record set that has the specified\n\t\t\t\t\tvalues.
\n DELETE: Deletes an existing resource record set that has the\n\t\t\t\t\tspecified values.
\n UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource\n\t\t\t\t\tset exists Route 53 updates it with the values in the request.
\n Syntaxes for Creating, Updating, and Deleting Resource Record\n\t\t\t\tSets\n
\nThe syntax for a request depends on the type of resource record set that you want to\n\t\t\tcreate, delete, or update, such as weighted, alias, or failover. The XML elements in\n\t\t\tyour request must appear in the order listed in the syntax.
\nFor an example for each type of resource record set, see \"Examples.\"
\nDon't refer to the syntax in the \"Parameter Syntax\" section, which includes\n\t\t\tall of the elements for every kind of resource record set that you can create, delete,\n\t\t\tor update by using ChangeResourceRecordSets.
\n Change Propagation to Route 53 DNS Servers\n
\nWhen you submit a ChangeResourceRecordSets request, Route 53 propagates your\n\t\t\tchanges to all of the Route 53 authoritative DNS servers managing the hosted zone. While\n\t\t\tyour changes are propagating, GetChange returns a status of\n\t\t\t\tPENDING. When propagation is complete, GetChange returns a\n\t\t\tstatus of INSYNC. Changes generally propagate to all Route 53 name servers\n\t\t\tmanaging the hosted zone within 60 seconds. For more information, see GetChange.
\n Limits on ChangeResourceRecordSets Requests\n
\nFor information about the limits on a ChangeResourceRecordSets request,\n\t\t\tsee Limits in the Amazon Route 53 Developer Guide.
A CIDR collection with this name and a different caller reference already exists in this account.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#CidrCollectionChange": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "Name of the location that is associated with the CIDR\n\t\t\tcollection.
", + "smithy.api#required": {} } - } - ] - } - }, - "output": { - "ChangeInfo": { - "Comment": "Web server for example.com", - "Id": "/change/C2682N5HXP0BZ4", - "Status": "PENDING", - "SubmittedAt": "2017-02-10T01:36:41.958Z" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/rrset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeResourceRecordSetsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tchange.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ChangeBatch": { - "target": "com.amazonaws.route53#ChangeBatch", - "traits": { - "smithy.api#documentation": "A complex type that contains an optional comment and the Changes\n\t\t\telement.
A complex type that contains change information for the resource record set.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ChangeResourceRecordSetsResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "A complex type that contains information about changes made to your hosted\n\t\t\tzone.
\nThis element contains an ID that you use when performing a GetChange action to get\n\t\t\tdetailed information about the change.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type containing the response for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ChangeStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "INSYNC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSYNC" - } - } - } - }, - "com.amazonaws.route53#ChangeTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ChangeTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.route53#ChangeTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "Adds, edits, or deletes tags for a health check or a hosted zone.
\nFor information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.
", - "smithy.api#examples": [ - { - "title": "To add or remove tags from a hosted zone or health check", - "documentation": "The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE.", - "input": { - "ResourceType": "hostedzone", - "ResourceId": "Z3M3LMPEXAMPLE", - "AddTags": [ - { - "Key": "apex", - "Value": "3874" }, - { - "Key": "acme", - "Value": "4938" + "Action": { + "target": "com.amazonaws.route53#CidrCollectionChangeAction", + "traits": { + "smithy.api#documentation": "CIDR collection change action.
", + "smithy.api#required": {} + } + }, + "CidrList": { + "target": "com.amazonaws.route53#CidrList", + "traits": { + "smithy.api#documentation": "List of CIDR blocks.
", + "smithy.api#required": {} + } } - ], - "RemoveTagKeys": ["Nadir"] }, - "output": {} - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ChangeTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "The type of the resource.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
The ID of the resource for which you want to add, change, or delete tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AddTags": { - "target": "com.amazonaws.route53#TagList", - "traits": { - "smithy.api#documentation": "A complex type that contains a list of the tags that you want to add to the specified\n\t\t\thealth check or hosted zone and/or the tags that you want to edit Value\n\t\t\tfor.
You can add a maximum of 10 tags to a health check or a hosted zone.
" - } - }, - "RemoveTagKeys": { - "target": "com.amazonaws.route53#TagKeyList", - "traits": { - "smithy.api#documentation": "A complex type that contains a list of the tags that you want to delete from the\n\t\t\tspecified health check or hosted zone. You can specify up to 10 keys.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the tags that you want to add, edit, or\n\t\t\tdelete.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ChangeTagsForResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Empty response for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Changes": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Change", - "traits": { - "smithy.api#xmlName": "Change" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#CheckerIpRanges": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#IPAddressCidr" - } - }, - "com.amazonaws.route53#ChildHealthCheckList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#xmlName": "ChildHealthCheck" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#Cidr": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.route53#CidrBlockInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "This CIDR block is already in use.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#CidrBlockSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CidrBlockSummary" - } - }, - "com.amazonaws.route53#CidrBlockSummary": { - "type": "structure", - "members": { - "CidrBlock": { - "target": "com.amazonaws.route53#Cidr", - "traits": { - "smithy.api#documentation": "Value for the CIDR block.
" - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "The location name of the CIDR block.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that lists the CIDR blocks.
" - } - }, - "com.amazonaws.route53#CidrCollection": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.route53#ARN", - "traits": { - "smithy.api#documentation": "The ARN of the collection. Can be used to reference the collection in IAM policy or in\n\t\t\tanother Amazon Web Services account.
" - } - }, - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "The unique ID of the CIDR collection.
" - } - }, - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "The name of a CIDR collection.
" - } - }, - "Version": { - "target": "com.amazonaws.route53#CollectionVersion", - "traits": { - "smithy.api#documentation": "A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex\n\t\t\ttype that\n\t\t\tidentifies a CIDR collection.
" - } - }, - "com.amazonaws.route53#CidrCollectionAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "A CIDR collection with this name and a different caller reference already exists in this account.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#CidrCollectionChange": { - "type": "structure", - "members": { - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "Name of the location that is associated with the CIDR\n\t\t\tcollection.
", - "smithy.api#required": {} - } - }, - "Action": { - "target": "com.amazonaws.route53#CidrCollectionChangeAction", - "traits": { - "smithy.api#documentation": "CIDR collection change action.
", - "smithy.api#required": {} - } - }, - "CidrList": { - "target": "com.amazonaws.route53#CidrList", - "traits": { - "smithy.api#documentation": "List of CIDR blocks.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the CIDR collection change.
" - } - }, - "com.amazonaws.route53#CidrCollectionChangeAction": { - "type": "enum", - "members": { - "PUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUT" - } - }, - "DELETE_IF_EXISTS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IF_EXISTS" - } - } - } - }, - "com.amazonaws.route53#CidrCollectionChanges": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CidrCollectionChange" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#CidrCollectionInUseException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "This CIDR collection is in use, and isn't empty.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#CidrCollectionVersionMismatchException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The CIDR collection version you provided, doesn't match the one in the\n\t\t\t\tListCidrCollections operation.
The CIDR collection ID.
", - "smithy.api#required": {} - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", - "traits": { - "smithy.api#documentation": "The CIDR collection location name.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The object that is specified in resource record set object when you are linking a\n\t\t\tresource record set to a CIDR location.
\nA LocationName with an asterisk “*” can be used to create a default CIDR\n\t\t\trecord. CollectionId is still required for default record.
For the metric that the CloudWatch alarm is associated with, the number of periods\n\t\t\tthat the metric is compared to the threshold.
", - "smithy.api#required": {} - } - }, - "Threshold": { - "target": "com.amazonaws.route53#Threshold", - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the value the metric is\n\t\t\tcompared with.
", - "smithy.api#required": {} - } - }, - "ComparisonOperator": { - "target": "com.amazonaws.route53#ComparisonOperator", - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the arithmetic operation\n\t\t\tthat is used for the comparison.
", - "smithy.api#required": {} - } - }, - "Period": { - "target": "com.amazonaws.route53#Period", - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the duration of one\n\t\t\tevaluation period in seconds.
", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.route53#MetricName", - "traits": { - "smithy.api#documentation": "The name of the CloudWatch metric that the alarm is associated with.
", - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.route53#Namespace", - "traits": { - "smithy.api#documentation": "The namespace of the metric that the alarm is associated with. For more information,\n\t\t\tsee Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.
", - "smithy.api#required": {} - } - }, - "Statistic": { - "target": "com.amazonaws.route53#Statistic", - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the statistic that is\n\t\t\tapplied to the metric.
", - "smithy.api#required": {} - } - }, - "Dimensions": { - "target": "com.amazonaws.route53#DimensionList", - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about the dimensions for the metric. For information, see Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.
" - } - }, - "com.amazonaws.route53#CloudWatchLogsLogGroupArn": { - "type": "string" - }, - "com.amazonaws.route53#CloudWatchRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "cn_northwest_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-northwest-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - }, - "us_gov_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-west-1" - } - }, - "us_gov_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-east-1" - } - }, - "us_iso_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-east-1" - } - }, - "us_iso_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-west-1" - } - }, - "us_isob_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-isob-east-1" - } - }, - "ap_southeast_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-4" - } - }, - "il_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "il-central-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#CollectionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" - } - }, - "com.amazonaws.route53#CollectionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#CollectionSummary" - } - }, - "com.amazonaws.route53#CollectionSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.route53#ARN", - "traits": { - "smithy.api#documentation": "The ARN of the collection summary. Can be used to reference the collection in IAM\n\t\t\tpolicy or cross-account.
" - } - }, - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "Unique ID for the CIDR collection.
" - } - }, - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "The name of a CIDR collection.
" - } - }, - "Version": { - "target": "com.amazonaws.route53#CollectionVersion", - "traits": { - "smithy.api#documentation": "A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that is an entry in an CidrCollection\n\t\t\tarray.
" - } - }, - "com.amazonaws.route53#CollectionVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#ComparisonOperator": { - "type": "enum", - "members": { - "GreaterThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" - } - }, - "GreaterThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GreaterThanThreshold" - } - }, - "LessThanThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanThreshold" - } - }, - "LessThanOrEqualToThreshold": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LessThanOrEqualToThreshold" - } - } - } - }, - "com.amazonaws.route53#ConcurrentModification": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "Another user submitted a request to create, update, or delete the object at the same\n\t\t\ttime that you did. Retry the request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#ConflictingDomainExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The cause of this error depends on the operation that you're performing:
\n\n Create a public hosted zone: Two hosted zones\n\t\t\t\t\tthat have the same name or that have a parent/child relationship (example.com\n\t\t\t\t\tand test.example.com) can't have any common name servers. You tried to create a\n\t\t\t\t\thosted zone that has the same name as an existing hosted zone or that's the\n\t\t\t\t\tparent or child of an existing hosted zone, and you specified a delegation set\n\t\t\t\t\tthat shares one or more name servers with the existing hosted zone. For more\n\t\t\t\t\tinformation, see CreateReusableDelegationSet.
\n\n Create a private hosted zone: A hosted zone\n\t\t\t\t\twith the specified name already exists and is already associated with the Amazon\n\t\t\t\t\tVPC that you specified.
\n\n Associate VPCs with a private hosted zone:\n\t\t\t\t\tThe VPC that you specified is already associated with another hosted zone that\n\t\t\t\t\thas the same name.
\nYou tried to update a traffic policy instance by using a traffic policy version that\n\t\t\thas a different DNS type than the current type for the instance. You specified the type\n\t\t\tin the JSON document in the CreateTrafficPolicy or\n\t\t\t\tCreateTrafficPolicyVersionrequest.
Creates a CIDR collection in the current Amazon Web Services account.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/cidrcollection", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateCidrCollectionRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#CollectionName", - "traits": { - "smithy.api#documentation": "A unique identifier for the account that can be used to reference the collection from\n\t\t\tother API calls.
", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#CidrNonce", - "traits": { - "smithy.api#documentation": "A client-specific token that allows requests to be securely retried so that the\n\t\t\tintended outcome will only occur once, retries receive a similar response, and there are\n\t\t\tno additional edge cases to handle.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateCidrCollectionResponse": { - "type": "structure", - "members": { - "Collection": { - "target": "com.amazonaws.route53#CidrCollection", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the CIDR collection.
" - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "A unique URL that represents the location for the CIDR collection.
", - "smithy.api#httpHeader": "Location" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckAlreadyExists" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#TooManyHealthChecks" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new health check.
\nFor information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
\n\n ELB Load Balancers\n
\nIf you're registering EC2 instances with an Elastic Load Balancing (ELB) load\n\t\t\tbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you\n\t\t\tregister an EC2 instance with a load balancer, you configure settings for an ELB health\n\t\t\tcheck, which performs a similar function to a Route 53 health check.
\n\n Private Hosted Zones\n
\nYou can associate health checks with failover resource record sets in a private hosted\n\t\t\tzone. Note the following:
\nRoute 53 health checkers are outside the VPC. To check the health of an\n\t\t\t\t\tendpoint within a VPC by IP address, you must assign a public IP address to the\n\t\t\t\t\tinstance in the VPC.
\nYou can configure a health checker to check the health of an external resource\n\t\t\t\t\tthat the instance relies on, such as a database server.
\nYou can create a CloudWatch metric, associate an alarm with the metric, and\n\t\t\t\t\tthen create a health check that is based on the state of the alarm. For example,\n\t\t\t\t\tyou might create a CloudWatch metric that checks the status of the Amazon EC2\n\t\t\t\t\t\tStatusCheckFailed metric, add an alarm to the metric, and then\n\t\t\t\t\tcreate a health check that is based on the state of the alarm. For information\n\t\t\t\t\tabout creating CloudWatch metrics and alarms by using the CloudWatch console,\n\t\t\t\t\tsee the Amazon\n\t\t\t\t\t\tCloudWatch User Guide.
A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference and settings as a previous request, and if the\n\t\t\t\t\thealth check doesn't exist, Amazon Route 53 creates the health check. If the\n\t\t\t\t\thealth check does exist, Route 53 returns the settings for the existing health\n\t\t\t\t\tcheck.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as a deleted health check, regardless of the\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as an existing health check but with different\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique\n\t\t\t\t\t\tCallerReference but settings identical to an existing health\n\t\t\t\t\tcheck, Route 53 creates the health check.
Route 53 does not store the CallerReference for a deleted health check indefinitely. \n\t\t\tThe CallerReference for a deleted health check will be deleted after a number of days.
A complex type that contains settings for a new health check.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the health check request information.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "A complex type that contains identifying information about the health check.
", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "The unique URL representing the new health check.
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type containing the response information for the new health check.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingDomainExists" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotAvailable" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#HostedZoneAlreadyExists" - }, - { - "target": "com.amazonaws.route53#InvalidDomainName" - }, - { - "target": "com.amazonaws.route53#InvalidInput" + "traits": { + "smithy.api#documentation": "A complex type that contains information about the CIDR collection change.
" + } }, - { - "target": "com.amazonaws.route53#InvalidVPCId" + "com.amazonaws.route53#CidrCollectionChangeAction": { + "type": "enum", + "members": { + "PUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUT" + } + }, + "DELETE_IF_EXISTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IF_EXISTS" + } + } + } }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" + "com.amazonaws.route53#CidrCollectionChanges": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CidrCollectionChange" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } }, - { - "target": "com.amazonaws.route53#TooManyHostedZones" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new public or private hosted zone. You create records in a public hosted\n\t\t\tzone to define how you want to route traffic on the internet for a domain, such as\n\t\t\texample.com, and its subdomains (apex.example.com, acme.example.com). You create records\n\t\t\tin a private hosted zone to define how you want to route traffic for a domain and its\n\t\t\tsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
\nYou can't convert a public hosted zone to a private hosted zone or vice versa.\n\t\t\t\tInstead, you must create a new hosted zone with the same name and create new\n\t\t\t\tresource record sets.
\nFor more information about charges for hosted zones, see Amazon Route 53 Pricing.
\nNote the following:
\nYou can't create a hosted zone for a top-level domain (TLD) such as\n\t\t\t\t\t.com.
\nFor public hosted zones, Route 53 automatically creates a default SOA record\n\t\t\t\t\tand four NS records for the zone. For more information about SOA and NS records,\n\t\t\t\t\tsee NS and SOA Records\n\t\t\t\t\t\tthat Route 53 Creates for a Hosted Zone in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you want to use the same name servers for multiple public hosted zones, you\n\t\t\t\t\tcan optionally associate a reusable delegation set with the hosted zone. See the\n\t\t\t\t\t\tDelegationSetId element.
If your domain is registered with a registrar other than Route 53,\n\t\t\t\t\tyou must update the name servers with your registrar to make Route 53 the DNS\n\t\t\t\t\tservice for the domain. For more information, see Migrating DNS Service\n\t\t\t\t\t\tfor an Existing Domain to Amazon Route 53 in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nWhen you submit a CreateHostedZone request, the initial status of the\n\t\t\thosted zone is PENDING. For public hosted zones, this means that the NS and\n\t\t\tSOA records are not yet available on all Route 53 DNS servers. When the NS and\n\t\t\tSOA records are available, the status of the zone changes to INSYNC.
The CreateHostedZone request requires the caller to have an\n\t\t\t\tec2:DescribeVpcs permission.
When creating private hosted zones, the Amazon VPC must belong to the same\n\t\t\t\tpartition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe name of the domain. Specify a fully qualified domain name, for example,\n\t\t\t\twww.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that\n\t\t\t\tRoute 53 treats www.example.com (without a trailing\n\t\t\tdot) and www.example.com. (with a trailing dot) as\n\t\t\tidentical.
\nIf you're creating a public hosted zone, this is the name you have registered with\n\t\t\tyour DNS registrar. If your domain name is registered with a registrar other than\n\t\t\t\tRoute 53, change the name servers for your domain to the set of\n\t\t\t\tNameServers that CreateHostedZone returns in\n\t\t\t\tDelegationSet.
(Private hosted zones only) A complex type that contains information about the Amazon\n\t\t\tVPC that you're associating with this hosted zone.
\nYou can specify only one Amazon VPC when you create a private hosted zone. If you are\n\t\t\tassociating a VPC with a hosted zone with this request, the paramaters\n\t\t\t\tVPCId and VPCRegion are also required.
To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.
" - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "A unique string that identifies the request and that allows failed\n\t\t\t\tCreateHostedZone requests to be retried without the risk of executing\n\t\t\tthe operation twice. You must use a unique CallerReference string every\n\t\t\ttime you submit a CreateHostedZone request. CallerReference\n\t\t\tcan be any unique string, for example, a date/time stamp.
(Optional) A complex type that contains the following optional values:
\nFor public and private hosted zones, an optional comment
\nFor private hosted zones, an optional PrivateZone element
If you don't specify a comment or the PrivateZone element, omit\n\t\t\t\tHostedZoneConfig and the other elements.
If you want to associate a reusable delegation set with this hosted zone, the ID that\n\t\t\t\tAmazon Route 53 assigned to the reusable delegation set when you created it.\n\t\t\tFor more information about reusable delegation sets, see CreateReusableDelegationSet.
\nIf you are using a reusable delegation set to create a public hosted zone for a subdomain,\n\t\t\tmake sure that the parent hosted zone doesn't use one or more of the same name servers.\n\t\t\tIf you have overlapping nameservers, the operation will cause a\n\t\t\t\tConflictingDomainsExist error.
A complex type that contains information about the request to create a public or\n\t\t\tprivate hosted zone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateHostedZoneResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
", - "smithy.api#required": {} - } - }, - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the CreateHostedZone\n\t\t\trequest.
A complex type that describes the name servers for this hosted zone.
", - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "A complex type that contains information about an Amazon VPC that you associated with\n\t\t\tthis hosted zone.
" - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "The unique URL representing the new hosted zone.
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type containing the response information for the hosted zone.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" + "com.amazonaws.route53#CidrCollectionInUseException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "This CIDR collection is in use, and isn't empty.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.route53#InvalidArgument" + "com.amazonaws.route53#CidrCollectionVersionMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The CIDR collection version you provided, doesn't match the one in the\n\t\t\t\tListCidrCollections operation.
The CIDR collection ID.
", + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "The CIDR collection location name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The object that is specified in resource record set object when you are linking a\n\t\t\tresource record set to a CIDR location.
\nA LocationName with an asterisk “*” can be used to create a default CIDR\n\t\t\trecord. CollectionId is still required for default record.
For the metric that the CloudWatch alarm is associated with, the number of periods\n\t\t\tthat the metric is compared to the threshold.
", + "smithy.api#required": {} + } + }, + "Threshold": { + "target": "com.amazonaws.route53#Threshold", + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the value the metric is\n\t\t\tcompared with.
", + "smithy.api#required": {} + } + }, + "ComparisonOperator": { + "target": "com.amazonaws.route53#ComparisonOperator", + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the arithmetic operation\n\t\t\tthat is used for the comparison.
", + "smithy.api#required": {} + } + }, + "Period": { + "target": "com.amazonaws.route53#Period", + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the duration of one\n\t\t\tevaluation period in seconds.
", + "smithy.api#required": {} + } + }, + "MetricName": { + "target": "com.amazonaws.route53#MetricName", + "traits": { + "smithy.api#documentation": "The name of the CloudWatch metric that the alarm is associated with.
", + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.route53#Namespace", + "traits": { + "smithy.api#documentation": "The namespace of the metric that the alarm is associated with. For more information,\n\t\t\tsee Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.
", + "smithy.api#required": {} + } + }, + "Statistic": { + "target": "com.amazonaws.route53#Statistic", + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the statistic that is\n\t\t\tapplied to the metric.
", + "smithy.api#required": {} + } + }, + "Dimensions": { + "target": "com.amazonaws.route53#DimensionList", + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about the dimensions for the metric. For information, see Amazon\n\t\t\t\tCloudWatch Namespaces, Dimensions, and Metrics Reference in the\n\t\t\t\tAmazon CloudWatch User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.
" + } }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" + "com.amazonaws.route53#CloudWatchLogsLogGroupArn": { + "type": "string" }, - { - "target": "com.amazonaws.route53#TooManyKeySigningKeys" - } - ], - "traits": { - "smithy.api#documentation": "Creates a new key-signing key (KSK) associated with a hosted zone. You can only have\n\t\t\ttwo KSKs per hosted zone.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/keysigningkey", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateKeySigningKeyRequest": { - "type": "structure", - "members": { - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "A unique string that identifies the request.
", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The unique string (ID) used to identify a hosted zone.
", - "smithy.api#required": {} - } - }, - "KeyManagementServiceArn": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "The Amazon resource name (ARN) for a customer managed key in Key Management Service\n\t\t\t\t(KMS). The KeyManagementServiceArn must be unique for\n\t\t\teach key-signing key (KSK) in a single hosted zone. To see an example of\n\t\t\t\tKeyManagementServiceArn that grants the correct permissions for DNSSEC,\n\t\t\tscroll down to Example.
You must configure the customer managed customer managed key as follows:
\nEnabled
\nECC_NIST_P256
\nSign and verify
\nThe key policy must give permission for the following actions:
\nDescribeKey
\nGetPublicKey
\nSign
\nThe key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:
\n\n \"Service\": \"dnssec-route53.amazonaws.com\"\n
For more information about working with a customer managed key in KMS, see Key Management Service concepts.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.
A string specifying the initial status of the key-signing key (KSK). You can set the\n\t\t\tvalue to ACTIVE or INACTIVE.
The key-signing key (KSK) that the request creates.
", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "The unique URL representing the new key-signing key (KSK).
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#QueryLoggingConfigAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.
\nDNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:
\nRoute 53 edge location that responded to the DNS query
\nDomain or subdomain that was requested
\nDNS record type, such as A or AAAA
\nDNS response code, such as NoError or\n\t\t\t\t\tServFail\n
Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.
\nIf you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.
\nCreate a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:
\nYou must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.
\nYou must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.
\nWhen you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:
\n\n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n
In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.
\nCreate a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:
\n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n
To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:
\nFor aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.
For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.
For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.
\nYou can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.
\nWhen Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:
\nCreates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.
\nBegins to send query logs to the applicable log stream.
\nThe name of each log stream is in the following format:
\n\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n
The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.
\nQuery logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nFor a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.
\nFor information about charges for query logs, see Amazon CloudWatch Pricing.
\nIf you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.
\nThe ID of the hosted zone that you want to log queries for. You can log queries only\n\t\t\tfor public hosted zones.
", - "smithy.api#required": {} - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to\n\t\t\tsend query logs to. This is the format of the ARN:
\narn:aws:logs:region:account-id:log-group:log_group_name\n
\nTo get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups\n\t\t\tcommand, or the applicable command in one of the Amazon Web Services SDKs.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateQueryLoggingConfigResponse": { - "type": "structure", - "members": { - "QueryLoggingConfig": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#documentation": "A complex type that contains the ID for a query logging configuration, the ID of the\n\t\t\thosted zone that you want to log queries for, and the ARN for the log group that you\n\t\t\twant Amazon Route 53 to send query logs to.
", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "The unique URL representing the new query logging configuration.
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetAlreadyCreated" - }, - { - "target": "com.amazonaws.route53#DelegationSetAlreadyReusable" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotAvailable" - }, - { - "target": "com.amazonaws.route53#HostedZoneNotFound" - }, - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#LimitsExceeded" - } - ], - "traits": { - "smithy.api#documentation": "Creates a delegation set (a group of four name servers) that can be reused by multiple\n\t\t\thosted zones that were created by the same Amazon Web Services account.
\nYou can also create a reusable delegation set that uses the four name servers that are\n\t\t\tassociated with an existing hosted zone. Specify the hosted zone ID in the\n\t\t\t\tCreateReusableDelegationSet request.
You can't associate a reusable delegation set with a private hosted zone.
\nFor information about using a reusable delegation set to configure white label name\n\t\t\tservers, see Configuring White\n\t\t\t\tLabel Name Servers.
\nThe process for migrating existing hosted zones to use a reusable delegation set is\n\t\t\tcomparable to the process for configuring white label name servers. You need to perform\n\t\t\tthe following steps:
\nCreate a reusable delegation set.
\nRecreate hosted zones, and reduce the TTL to 60 seconds or less.
\nRecreate resource record sets in the new hosted zones.
\nChange the registrar's name servers to use the name servers for the new hosted\n\t\t\t\t\tzones.
\nMonitor traffic for the website or application.
\nChange TTLs back to their original values.
\nIf you want to migrate existing hosted zones to use a reusable delegation set, the\n\t\t\texisting hosted zones can't use any of the name servers that are assigned to the\n\t\t\treusable delegation set. If one or more hosted zones do use one or more name servers\n\t\t\tthat are assigned to the reusable delegation set, you can do one of the\n\t\t\tfollowing:
\nFor small numbers of hosted zones—up to a few hundred—it's\n\t\t\t\t\trelatively easy to create reusable delegation sets until you get one that has\n\t\t\t\t\tfour name servers that don't overlap with any of the name servers in your hosted\n\t\t\t\t\tzones.
\nFor larger numbers of hosted zones, the easiest solution is to use more than\n\t\t\t\t\tone reusable delegation set.
\nFor larger numbers of hosted zones, you can also migrate hosted zones that\n\t\t\t\t\thave overlapping name servers to hosted zones that don't have overlapping name\n\t\t\t\t\tservers, then migrate the hosted zones again to use the reusable delegation\n\t\t\t\t\tset.
\nA unique string that identifies the request, and that allows you to retry failed\n\t\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time\n\t\t\tyou submit a CreateReusableDelegationSet request.\n\t\t\t\tCallerReference can be any unique string, for example a date/time\n\t\t\tstamp.
If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateReusableDelegationSetResponse": { - "type": "structure", - "members": { - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "A complex type that contains name server information.
", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "The unique URL representing the new reusable delegation set.
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicies" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "Creates a traffic policy, which you use to create multiple DNS resource record sets\n\t\t\tfor one domain name (such as example.com) or one subdomain name (such as\n\t\t\twww.example.com).
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TooManyTrafficPolicyInstances" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists" - } - ], - "traits": { - "smithy.api#documentation": "Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.
After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.
The ID of the hosted zone that you want Amazon Route 53 to create resource record sets\n\t\t\tin by using the configuration in a traffic policy.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "The domain name (such as example.com) or subdomain name (such as www.example.com) for\n\t\t\twhich Amazon Route 53 responds to DNS queries by using the resource record sets that\n\t\t\tRoute 53 creates for this traffic policy instance.
", - "smithy.api#required": {} - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource\n\t\t\trecord sets that it creates in the specified hosted zone.
", - "smithy.api#required": {} - } - }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "The ID of the traffic policy that you want to use to create resource record sets in\n\t\t\tthe specified hosted zone.
", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version of the traffic policy that you want to use to create resource record sets\n\t\t\tin the specified hosted zone.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the resource record sets that you want\n\t\t\tto create based on a specified traffic policy.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the new traffic policy instance.
", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "A unique URL that represents a new traffic policy instance.
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyInstance request.
The name of the traffic policy.
", - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.
", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#TrafficPolicyComment", - "traits": { - "smithy.api#documentation": "(Optional) Any comments that you want to include about the traffic policy.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the new traffic policy.
", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "A unique URL that represents a new traffic policy.
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicy request.
Creates a new version of an existing traffic policy. When you create a new version of\n\t\t\ta traffic policy, you specify the ID of the traffic policy that you want to update and a\n\t\t\tJSON-formatted document that describes the new version. You use traffic policies to\n\t\t\tcreate multiple DNS resource record sets for one domain name (such as example.com) or\n\t\t\tone subdomain name (such as www.example.com). You can create a maximum of 1000 versions\n\t\t\tof a traffic policy. If you reach the limit and need to create another version, you'll\n\t\t\tneed to start a new traffic policy.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy/{Id}", - "code": 201 - } - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "The ID of the traffic policy for which you want to create a new version.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "The definition of this version of the traffic policy, in JSON format. You specified\n\t\t\tthe JSON in the CreateTrafficPolicyVersion request. For more information\n\t\t\tabout the JSON format, see CreateTrafficPolicy.
The comment that you specified in the CreateTrafficPolicyVersion request,\n\t\t\tif any.
A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate a new version for.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateTrafficPolicyVersionResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the new version of the traffic\n\t\t\tpolicy.
", - "smithy.api#required": {} - } - }, - "Location": { - "target": "com.amazonaws.route53#ResourceURI", - "traits": { - "smithy.api#documentation": "A unique URL that represents a new traffic policy version.
", - "smithy.api#httpHeader": "Location", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyVersion request.
Authorizes the Amazon Web Services account that created a specified VPC to submit an\n\t\t\t\tAssociateVPCWithHostedZone request to associate the VPC with a\n\t\t\tspecified hosted zone that was created by a different account. To submit a\n\t\t\t\tCreateVPCAssociationAuthorization request, you must use the account\n\t\t\tthat created the hosted zone. After you authorize the association, use the account that\n\t\t\tcreated the VPC to submit an AssociateVPCWithHostedZone request.
If you want to associate multiple VPCs that you created by using one account with\n\t\t\t\ta hosted zone that you created by using a different account, you must submit one\n\t\t\t\tauthorization request for each VPC.
\nThe ID of the private hosted zone that you want to authorize associating a VPC\n\t\t\twith.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "A complex type that contains the VPC ID and region for the VPC that you want to\n\t\t\tauthorize associating with your hosted zone.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the request to authorize associating a\n\t\t\tVPC with your private hosted zone. Authorization is only required when a private hosted\n\t\t\tzone and a VPC were created by using different accounts.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the hosted zone that you authorized associating a VPC with.
", - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "The VPC that you authorized associating with a hosted zone.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information from a\n\t\t\t\tCreateVPCAssociationAuthorization request.
The hosted zone doesn't have any DNSSEC resources.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#DNSSECStatus": { - "type": "structure", - "members": { - "ServeSignature": { - "target": "com.amazonaws.route53#ServeSignature", - "traits": { - "smithy.api#documentation": "A string that represents the current hosted zone signing status.
\nStatus can have one of the following values:
\nDNSSEC signing is enabled for the hosted zone.
\nDNSSEC signing is not enabled for the hosted zone.
\nDNSSEC signing is in the process of being removed for the hosted\n\t\t\t\t\t\tzone.
\nThere is a problem with signing in the hosted zone that requires you to\n\t\t\t\t\t\ttake action to resolve. For example, the customer managed key might have\n\t\t\t\t\t\tbeen deleted, or the permissions for the customer managed key might have\n\t\t\t\t\t\tbeen changed.
\nThere was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including with key-signing keys (KSKs), you must correct the\n\t\t\t\t\t\tproblem by enabling or disabling DNSSEC signing for the hosted zone.
\nThe status message provided for the following DNSSEC signing status:\n\t\t\t\tINTERNAL_FAILURE. The status message includes information about what\n\t\t\tthe problem might be and steps that you can take to correct the issue.
A string repesenting the status of DNSSEC signing.
" - } - }, - "com.amazonaws.route53#DeactivateKeySigningKey": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeactivateKeySigningKeyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeactivateKeySigningKeyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidSigningStatus" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInUse" - }, - { - "target": "com.amazonaws.route53#NoSuchKeySigningKey" - } - ], - "traits": { - "smithy.api#documentation": "Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.\n\t\t\tThis operation changes the KSK status to INACTIVE.
A unique string used to identify a hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "A string used to identify a key-signing key (KSK).
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeactivateKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DelegationSet": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID that Amazon Route 53 assigns to a reusable delegation set.
" - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#Nonce", - "traits": { - "smithy.api#documentation": "The value that you specified for CallerReference when you created the\n\t\t\treusable delegation set.
A complex type that contains a list of the authoritative name servers for a hosted\n\t\t\tzone or for a reusable delegation set.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that lists the name servers in a delegation set, as well as the\n\t\t\t\tCallerReference and the ID for the delegation set.
A delegation set with the same owner and caller reference combination has already been\n\t\t\tcreated.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetAlreadyReusable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified delegation set has already been marked as reusable.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified delegation contains associated hosted zones which must be deleted before\n\t\t\tthe reusable delegation set can be deleted.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetNameServers": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#xmlName": "NameServer" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#DelegationSetNotAvailable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "You can create a hosted zone that has the same name as an existing hosted zone\n\t\t\t(example.com is common), but there is a limit to the number of hosted zones that have\n\t\t\tthe same name. If you get this error, Amazon Route 53 has reached that limit. If you own\n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSetNotReusable": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "A reusable delegation set with the specified ID does not exist.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#DelegationSets": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#xmlName": "DelegationSet" - } - } - }, - "com.amazonaws.route53#DeleteCidrCollection": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteCidrCollectionRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteCidrCollectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#CidrCollectionInUseException" - }, - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a CIDR collection in the current Amazon Web Services account. The collection\n\t\t\tmust be empty before it can be deleted.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/cidrcollection/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteCidrCollectionRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "The UUID of the collection to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteCidrCollectionResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckInUse" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a health check.
\nAmazon Route 53 does not prevent you from deleting a health check even if the\n\t\t\t\thealth check is associated with one or more resource record sets. If you delete a\n\t\t\t\thealth check and you don't update the associated resource record sets, the future\n\t\t\t\tstatus of the health check can't be predicted and may change. This will affect the\n\t\t\t\trouting of DNS queries for your DNS failover configuration. For more information,\n\t\t\t\tsee Replacing and Deleting Health Checks in the Amazon Route 53\n\t\t\t\t\tDeveloper Guide.
\nIf you're using Cloud Map and you configured Cloud Map to create a Route 53\n\t\t\thealth check when you register an instance, you can't use the Route 53\n\t\t\t\tDeleteHealthCheck command to delete the health check. The health check\n\t\t\tis deleted automatically when you deregister the instance; there can be a delay of\n\t\t\tseveral hours before the health check is deleted from Route 53.
The ID of the health check that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "This action deletes a health check.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteHealthCheckResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "An empty element.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HostedZoneNotEmpty" - }, - { - "target": "com.amazonaws.route53#InvalidDomainName" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a hosted zone.
\nIf the hosted zone was created by another service, such as Cloud Map, see\n\t\t\t\tDeleting Public Hosted Zones That Were Created by Another Service in the\n\t\t\t\t\tAmazon Route 53 Developer Guide for information\n\t\t\tabout how to delete it. (The process is the same for public and private hosted zones\n\t\t\tthat were created by another service.)
\nIf you want to keep your domain registration but you want to stop routing internet\n\t\t\ttraffic to your website or web application, we recommend that you delete resource record\n\t\t\tsets in the hosted zone instead of deleting the hosted zone.
\nIf you delete a hosted zone, you can't undelete it. You must create a new hosted\n\t\t\t\tzone and update the name servers for your domain registration, which can require up\n\t\t\t\tto 48 hours to take effect. (If you delegated responsibility for a subdomain to a\n\t\t\t\thosted zone and you delete the child hosted zone, you must update the name servers\n\t\t\t\tin the parent hosted zone.) In addition, if you delete a hosted zone, someone could\n\t\t\t\thijack the domain and route traffic to their own resources using your domain\n\t\t\t\tname.
\nIf you want to avoid the monthly charge for the hosted zone, you can transfer DNS\n\t\t\tservice for the domain to a free DNS service. When you transfer DNS service, you have to\n\t\t\tupdate the name servers for the domain registration. If the domain is registered with\n\t\t\t\tRoute 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is\n\t\t\tregistered with another registrar, use the method provided by the registrar to update\n\t\t\tname servers for the domain registration. For more information, perform an internet\n\t\t\tsearch on \"free DNS service.\"
\nYou can delete a hosted zone only if it contains only the default SOA record and NS\n\t\t\tresource record sets. If the hosted zone contains other resource record sets, you must\n\t\t\tdelete them before you can delete the hosted zone. If you try to delete a hosted zone\n\t\t\tthat contains other resource record sets, the request fails, and Route 53\n\t\t\treturns a HostedZoneNotEmpty error. For information about deleting records\n\t\t\tfrom your hosted zone, see ChangeResourceRecordSets.
To verify that the hosted zone has been deleted, do one of the following:
\nUse the GetHostedZone action to request information about the\n\t\t\t\t\thosted zone.
Use the ListHostedZones action to get a list of the hosted zones\n\t\t\t\t\tassociated with the current Amazon Web Services account.
The ID of the hosted zone you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A request to delete a hosted zone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "A complex type that contains the ID, the status, and the date and time of a request to\n\t\t\tdelete a hosted zone.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response to a DeleteHostedZone\n\t\t\trequest.
Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it.\n\t\t\tThe KSK must be deactivated before you can delete it regardless of whether the hosted\n\t\t\tzone is enabled for DNSSEC signing.
\nYou can use DeactivateKeySigningKey to deactivate the key before you delete it.
\nUse GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.
A unique string used to identify a hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "A string used to identify a key-signing key (KSK).
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteKeySigningKeyResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfigRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteQueryLoggingConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a configuration for DNS query logging. If you delete a configuration, Amazon\n\t\t\tRoute 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs\n\t\t\tthat are already in CloudWatch Logs.
\nFor more information about DNS query logs, see CreateQueryLoggingConfig.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/queryloggingconfig/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "The ID of the configuration that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteQueryLoggingConfigResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetInUse" - }, - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a reusable delegation set.
\nYou can delete a reusable delegation set only if it isn't associated with any\n\t\t\t\thosted zones.
\nTo verify that the reusable delegation set is not associated with any hosted zones,\n\t\t\tsubmit a GetReusableDelegationSet request and specify the ID of the reusable\n\t\t\tdelegation set that you want to delete.
", - "smithy.api#http": { - "method": "DELETE", - "uri": "/2013-04-01/delegationset/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#DeleteReusableDelegationSetRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the reusable delegation set that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A request to delete a reusable delegation set.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteReusableDelegationSetResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "An empty element.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteTrafficPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#TrafficPolicyInUse" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a traffic policy.
\nWhen you delete a traffic policy, Route 53 sets a flag on the policy to indicate that\n\t\t\tit has been deleted. However, Route 53 never fully deletes the traffic policy. Note the\n\t\t\tfollowing:
\nDeleted traffic policies aren't listed if you run ListTrafficPolicies.
\nThere's no way to get a list of deleted policies.
\nIf you retain the ID of the policy, you can get information about the policy,\n\t\t\t\t\tincluding the traffic policy document, by running GetTrafficPolicy.
\nDeletes a traffic policy instance and all of the resource record sets that Amazon\n\t\t\tRoute 53 created when you created the instance.
\nIn the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nThe ID of the traffic policy instance that you want to delete.
\nWhen you delete a traffic policy instance, Amazon Route 53 also deletes all of the\n\t\t\t\tresource record sets that were created when you created the traffic policy\n\t\t\t\tinstance.
\nA request to delete a specified traffic policy instance.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "An empty element.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "The ID of the traffic policy that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version number of the traffic policy that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A request to delete a specified traffic policy version.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteTrafficPolicyResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "An empty element.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#DeleteVPCAssociationAuthorization": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest" - }, - "output": { - "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#VPCAssociationAuthorizationNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Removes authorization to submit an AssociateVPCWithHostedZone request to\n\t\t\tassociate a specified VPC with a hosted zone that was created by a different account.\n\t\t\tYou must use the account that created the hosted zone to submit a\n\t\t\t\tDeleteVPCAssociationAuthorization request.
Sending this request only prevents the Amazon Web Services account that created the\n\t\t\t\tVPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If\n\t\t\t\tthe VPC is already associated with the hosted zone,\n\t\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from\n\t\t\t\tthe hosted zone. If you want to delete an existing association, use\n\t\t\t\t\tDisassociateVPCFromHostedZone.
When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the\n\t\t\tVPC.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the request to remove authorization to\n\t\t\tassociate a VPC that was created by one Amazon Web Services account with a hosted zone\n\t\t\tthat was created with a different Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Empty response for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Dimension": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#DimensionField", - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the name of one\n\t\t\tdimension.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.route53#DimensionField", - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the value of one\n\t\t\tdimension.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about one dimension.
" - } - }, - "com.amazonaws.route53#DimensionField": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#DimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Dimension", - "traits": { - "smithy.api#xmlName": "Dimension" - } - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#DisableHostedZoneDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" - }, - { - "target": "com.amazonaws.route53#DNSSECNotFound" - }, - { - "target": "com.amazonaws.route53#InvalidArgument" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" - }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" - }, - { - "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any\n\t\t\tkey-signing keys (KSKs) that are active in the hosted zone.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "A unique string used to identify a hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DisableHostedZoneDNSSECResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#Disabled": { - "type": "boolean" - }, - "com.amazonaws.route53#DisassociateVPCComment": { - "type": "string" - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZone": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest" - }, - "output": { - "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidVPCId" - }, - { - "target": "com.amazonaws.route53#LastVPCAssociation" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#VPCAssociationNotFound" - } - ], - "traits": { - "smithy.api#documentation": "Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53\n\t\t\tprivate hosted zone. Note the following:
\nYou can't disassociate the last Amazon VPC from a private hosted zone.
\nYou can't convert a private hosted zone into a public hosted zone.
\nYou can submit a DisassociateVPCFromHostedZone request using\n\t\t\t\t\teither the account that created the hosted zone or the account that created the\n\t\t\t\t\tAmazon VPC.
Some services, such as Cloud Map and Amazon Elastic File System\n\t\t\t\t\t(Amazon EFS) automatically create hosted zones and associate VPCs with the\n\t\t\t\t\thosted zones. A service can create a hosted zone using your account or using its\n\t\t\t\t\town account. You can disassociate a VPC from a hosted zone only if the service\n\t\t\t\t\tcreated the hosted zone using your account.
\nWhen you run DisassociateVPCFromHostedZone, if the hosted zone has a value for\n\t\t\t\t\t\tOwningAccount, you can use\n\t\t\t\t\t\tDisassociateVPCFromHostedZone. If the hosted zone has a value\n\t\t\t\t\tfor OwningService, you can't use\n\t\t\t\t\t\tDisassociateVPCFromHostedZone.
When revoking access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe ID of the private hosted zone that you want to disassociate a VPC from.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPC": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the VPC that you're disassociating from\n\t\t\tthe specified hosted zone.
", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#DisassociateVPCComment", - "traits": { - "smithy.api#documentation": "\n Optional: A comment about the disassociation request.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the VPC that you want to disassociate\n\t\t\tfrom a specified private hosted zone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "A complex type that describes the changes made to the specified private hosted\n\t\t\tzone.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the disassociate\n\t\t\trequest.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSEC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSECRequest" - }, - "output": { - "target": "com.amazonaws.route53#EnableHostedZoneDNSSECResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConcurrentModification" + "com.amazonaws.route53#CloudWatchRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "cn_northwest_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_iso_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-east-1" + } + }, + "us_iso_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-west-1" + } + }, + "us_isob_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-isob-east-1" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } + }, + "ca_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-west-1" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } }, - { - "target": "com.amazonaws.route53#DNSSECNotFound" + "com.amazonaws.route53#CollectionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-]+$" + } }, - { - "target": "com.amazonaws.route53#HostedZonePartiallyDelegated" + "com.amazonaws.route53#CollectionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#CollectionSummary" + } }, - { - "target": "com.amazonaws.route53#InvalidArgument" + "com.amazonaws.route53#CollectionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.route53#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the collection summary. Can be used to reference the collection in IAM\n\t\t\tpolicy or cross-account.
" + } + }, + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "Unique ID for the CIDR collection.
" + } + }, + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "The name of a CIDR collection.
" + } + }, + "Version": { + "target": "com.amazonaws.route53#CollectionVersion", + "traits": { + "smithy.api#documentation": "A sequential counter that Route 53 sets to 1 when you create a CIDR\n\t\t\tcollection and increments by 1 each time you update settings for the CIDR\n\t\t\tcollection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that is an entry in an CidrCollection\n\t\t\tarray.
" + } }, - { - "target": "com.amazonaws.route53#InvalidInput" + "com.amazonaws.route53#CollectionVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } }, - { - "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + "com.amazonaws.route53#ComparisonOperator": { + "type": "enum", + "members": { + "GreaterThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanOrEqualToThreshold" + } + }, + "GreaterThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GreaterThanThreshold" + } + }, + "LessThanThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanThreshold" + } + }, + "LessThanOrEqualToThreshold": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LessThanOrEqualToThreshold" + } + } + } }, - { - "target": "com.amazonaws.route53#InvalidKMSArn" + "com.amazonaws.route53#ConcurrentModification": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "Another user submitted a request to create, update, or delete the object at the same\n\t\t\ttime that you did. Retry the request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound" + "com.amazonaws.route53#ConflictingDomainExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The cause of this error depends on the operation that you're performing:
\n\n Create a public hosted zone: Two hosted zones\n\t\t\t\t\tthat have the same name or that have a parent/child relationship (example.com\n\t\t\t\t\tand test.example.com) can't have any common name servers. You tried to create a\n\t\t\t\t\thosted zone that has the same name as an existing hosted zone or that's the\n\t\t\t\t\tparent or child of an existing hosted zone, and you specified a delegation set\n\t\t\t\t\tthat shares one or more name servers with the existing hosted zone. For more\n\t\t\t\t\tinformation, see CreateReusableDelegationSet.
\n\n Create a private hosted zone: A hosted zone\n\t\t\t\t\twith the specified name already exists and is already associated with the Amazon\n\t\t\t\t\tVPC that you specified.
\n\n Associate VPCs with a private hosted zone:\n\t\t\t\t\tThe VPC that you specified is already associated with another hosted zone that\n\t\t\t\t\thas the same name.
\nEnables DNSSEC signing in a specific hosted zone.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/enable-dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "A unique string used to identify a hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#EnableHostedZoneDNSSECResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#EnableSNI": { - "type": "boolean" - }, - "com.amazonaws.route53#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.route53#ErrorMessages": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#xmlName": "Message" - } - } - }, - "com.amazonaws.route53#EvaluationPeriods": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#FailureThreshold": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#FullyQualifiedDomainName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#GeoLocation": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "The two-letter code for the continent.
\nAmazon Route 53 supports the following continent codes:
\n\n AF: Africa
\n\n AN: Antarctica
\n\n AS: Asia
\n\n EU: Europe
\n\n OC: Oceania
\n\n NA: North America
\n\n SA: South America
\nConstraint: Specifying ContinentCode with either CountryCode\n\t\t\tor SubdivisionCode returns an InvalidInput error.
For geolocation resource record sets, the two-letter code for a country.
\nAmazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
\nRoute 53 also supports the contry code UA forr Ukraine.
" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "For geolocation resource record sets, the two-letter code for a state of the United\n\t\t\tStates. Route 53 doesn't support any other values for SubdivisionCode. For\n\t\t\ta list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United\n\t\t\tStates Postal Service website.
If you specify subdivisioncode, you must also specify US for\n\t\t\t\tCountryCode.
A complex type that contains information about a geographic location.
" - } - }, - "com.amazonaws.route53#GeoLocationContinentCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.route53#GeoLocationContinentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.route53#GeoLocationCountryCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.route53#GeoLocationCountryName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#GeoLocationDetails": { - "type": "structure", - "members": { - "ContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "The two-letter code for the continent.
" - } - }, - "ContinentName": { - "target": "com.amazonaws.route53#GeoLocationContinentName", - "traits": { - "smithy.api#documentation": "The full name of the continent.
" - } - }, - "CountryCode": { - "target": "com.amazonaws.route53#GeoLocationCountryCode", - "traits": { - "smithy.api#documentation": "The two-letter code for the country.
" - } - }, - "CountryName": { - "target": "com.amazonaws.route53#GeoLocationCountryName", - "traits": { - "smithy.api#documentation": "The name of the country.
" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.
" - } - }, - "SubdivisionName": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionName", - "traits": { - "smithy.api#documentation": "The full name of the subdivision. Route 53 currently supports only states in the\n\t\t\tUnited States.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.
Gets the specified limit for the current account, for example, the maximum number of\n\t\t\thealth checks that you can create using the account.
\nFor the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.
\nYou can also view account limits in Amazon Web Services Trusted Advisor. Sign in to\n\t\t\t\tthe Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.
\nThe limit that you want to get. Valid values include the following:
\n\n MAX_HEALTH_CHECKS_BY_OWNER: The maximum\n\t\t\t\t\tnumber of health checks that you can create using the current account.
\n\n MAX_HOSTED_ZONES_BY_OWNER: The maximum number\n\t\t\t\t\tof hosted zones that you can create using the current account.
\n\n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The\n\t\t\t\t\tmaximum number of reusable delegation sets that you can create using the current\n\t\t\t\t\taccount.
\n\n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum\n\t\t\t\t\tnumber of traffic policies that you can create using the current account.
\n\n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The\n\t\t\t\t\tmaximum number of traffic policy instances that you can create using the current\n\t\t\t\t\taccount. (Traffic policy instances are referred to as traffic flow policy\n\t\t\t\t\trecords in the Amazon Route 53 console.)
\nA complex type that contains information about the request to create a hosted\n\t\t\tzone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetAccountLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#AccountLimit", - "traits": { - "smithy.api#documentation": "The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the\n\t\t\trequest, the value of Limit is the maximum number of health checks that you\n\t\t\tcan create using the current account.
The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of health checks that you have created using the current account.
A complex type that contains the requested limit.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetChange": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetChangeRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetChangeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchChange" - } - ], - "traits": { - "smithy.api#documentation": "Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:
\n\n PENDING indicates that the changes in this request have not\n\t\t\t\t\tpropagated to all Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all\n\t\t\t\t\tchange batch requests.
\n INSYNC indicates that the changes have propagated to all Route 53\n\t\t\t\t\tDNS servers managing the hosted zone.
You tried to update a traffic policy instance by using a traffic policy version that\n\t\t\thas a different DNS type than the current type for the instance. You specified the type\n\t\t\tin the JSON document in the CreateTrafficPolicy or\n\t\t\t\tCreateTrafficPolicyVersionrequest.
The ID of the change batch request. The value that you specify here is the value that\n\t\t\t\tChangeResourceRecordSets returned in the Id element when\n\t\t\tyou submitted the request.
The input for a GetChange request.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetChangeResponse": { - "type": "structure", - "members": { - "ChangeInfo": { - "target": "com.amazonaws.route53#ChangeInfo", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the specified change batch.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the ChangeInfo element.
Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.
\n\n GetCheckerIpRanges still works, but we recommend that you download\n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services\n\t\t\t\tservices. For more information, see IP Address Ranges\n\t\t\t\t\tof Amazon Route 53 Servers in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.
Empty request.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetCheckerIpRangesResponse": { - "type": "structure", - "members": { - "CheckerIpRanges": { - "target": "com.amazonaws.route53#CheckerIpRanges", - "traits": { - "smithy.api#documentation": "A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route\n\t\t\t53 health checkers.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the CheckerIpRanges element.
Returns information about DNSSEC for a specific hosted zone, including the key-signing\n\t\t\tkeys (KSKs) in the hosted zone.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetDNSSECRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "A unique string used to identify a hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetDNSSECResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.route53#DNSSECStatus", - "traits": { - "smithy.api#documentation": "A string repesenting the status of DNSSEC.
", - "smithy.api#required": {} - } - }, - "KeySigningKeys": { - "target": "com.amazonaws.route53#KeySigningKeys", - "traits": { - "smithy.api#documentation": "The key-signing keys (KSKs) in your account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetGeoLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetGeoLocationRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetGeoLocationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchGeoLocation" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about whether a specified geographic location is supported for Amazon\n\t\t\tRoute 53 geolocation resource record sets.
\nRoute 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.
\nUse the following syntax to determine whether a continent is supported for\n\t\t\tgeolocation:
\n\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for\n\t\t\t\t\ta continent\n \n
Use the following syntax to determine whether a country is supported for\n\t\t\tgeolocation:
\n\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode\n \n
Use the following syntax to determine whether a subdivision of a country is supported\n\t\t\tfor geolocation:
\n\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode&subdivisioncode=subdivision\n\t\t\tcode\n \n
For geolocation resource record sets, a two-letter abbreviation that identifies a\n\t\t\tcontinent. Amazon Route 53 supports the following continent codes:
\n\n AF: Africa
\n\n AN: Antarctica
\n\n AS: Asia
\n\n EU: Europe
\n\n OC: Oceania
\n\n NA: North America
\n\n SA: South America
\nAmazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
\nRoute 53 also supports the contry code UA forr Ukraine.
", - "smithy.api#httpQuery": "countrycode" - } - }, - "SubdivisionCode": { - "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", - "traits": { - "smithy.api#documentation": "The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.
", - "smithy.api#httpQuery": "subdivisioncode" - } - } - }, - "traits": { - "smithy.api#documentation": "A request for information about whether a specified geographic location is supported\n\t\t\tfor Amazon Route 53 geolocation resource record sets.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetGeoLocationResponse": { - "type": "structure", - "members": { - "GeoLocationDetails": { - "target": "com.amazonaws.route53#GeoLocationDetails", - "traits": { - "smithy.api#documentation": "A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the specified geolocation\n\t\t\tcode.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#IncompatibleVersion" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about a specified health check.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHealthCheckCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHealthCheckCountResponse" - }, - "traits": { - "smithy.api#documentation": "Retrieves the number of health checks that are associated with the current Amazon Web Services account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheckcount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "A request for the number of health checks that are associated with the current Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckCountResponse": { - "type": "structure", - "members": { - "HealthCheckCount": { - "target": "com.amazonaws.route53#HealthCheckCount", - "traits": { - "smithy.api#documentation": "The number of health checks associated with the current Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response to a GetHealthCheckCount\n\t\t\trequest.
Gets the reason that a specified health check failed most recently.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "The ID for the health check for which you want the last failure reason. When you\n\t\t\tcreated the health check, CreateHealthCheck returned the ID in the\n\t\t\tresponse, in the HealthCheckId element.
If you want to get the last failure reason for a calculated health check, you must\n\t\t\t\tuse the Amazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckLastFailureReason for a calculated health\n\t\t\t\tcheck.
A request for the reason that a health check failed most recently.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse": { - "type": "structure", - "members": { - "HealthCheckObservations": { - "target": "com.amazonaws.route53#HealthCheckObservations", - "traits": { - "smithy.api#documentation": "A list that contains one Observation element for each Amazon Route 53\n\t\t\thealth checker that is reporting a last failure reason.
A complex type that contains the response to a\n\t\t\t\tGetHealthCheckLastFailureReason request.
The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A request to get information about a specified health check.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.
Gets status of a specified health check.
\nThis API is intended for use during development to diagnose behavior. It doesn’t\n\t\t\t\tsupport production use-cases with high query rates that require immediate and\n\t\t\t\tactionable responses.
\nThe ID for the health check that you want the current status for. When you created the\n\t\t\thealth check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.
If you want to check the status of a calculated health check, you must use the\n\t\t\t\tAmazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckStatus to get the status of a calculated health\n\t\t\t\tcheck.
A request to get the status for a health check.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHealthCheckStatusResponse": { - "type": "structure", - "members": { - "HealthCheckObservations": { - "target": "com.amazonaws.route53#HealthCheckObservations", - "traits": { - "smithy.api#documentation": "A list that contains one HealthCheckObservation element for each Amazon\n\t\t\tRoute 53 health checker that is reporting a status about the health check\n\t\t\tendpoint.
A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.
Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.
", - "smithy.api#examples": [ - { - "title": "To get information about a hosted zone", - "documentation": "The following example gets information about the Z3M3LMPEXAMPLE hosted zone.", + "traits": { + "smithy.api#documentation": "Creates a CIDR collection in the current Amazon Web Services account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/cidrcollection", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateCidrCollectionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#CollectionName", + "traits": { + "smithy.api#documentation": "A unique identifier for the account that can be used to reference the collection from\n\t\t\tother API calls.
", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#CidrNonce", + "traits": { + "smithy.api#documentation": "A client-specific token that allows requests to be securely retried so that the\n\t\t\tintended outcome will only occur once, retries receive a similar response, and there are\n\t\t\tno additional edge cases to handle.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateCidrCollectionResponse": { + "type": "structure", + "members": { + "Collection": { + "target": "com.amazonaws.route53#CidrCollection", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the CIDR collection.
" + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "A unique URL that represents the location for the CIDR collection.
", + "smithy.api#httpHeader": "Location" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateHealthCheck": { + "type": "operation", "input": { - "Id": "Z3M3LMPEXAMPLE" + "target": "com.amazonaws.route53#CreateHealthCheckRequest" }, "output": { - "HostedZone": { - "ResourceRecordSetCount": 8, - "CallerReference": "C741617D-04E4-F8DE-B9D7-0D150FC61C2E", - "Config": { - "PrivateZone": false - }, - "Id": "/hostedzone/Z3M3LMPEXAMPLE", - "Name": "myawsbucket.com." - }, - "DelegationSet": { - "NameServers": [ - "ns-2048.awsdns-64.com", - "ns-2049.awsdns-65.net", - "ns-2050.awsdns-66.org", - "ns-2051.awsdns-67.co.uk" - ] - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneCount": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetHostedZoneCountRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetHostedZoneCountResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonecount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "A request to retrieve a count of all the hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHostedZoneCountResponse": { - "type": "structure", - "members": { - "HostedZoneCount": { - "target": "com.amazonaws.route53#HostedZoneCount", - "traits": { - "smithy.api#documentation": "The total number of public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response to a GetHostedZoneCount\n\t\t\trequest.
Gets the specified limit for a specified hosted zone, for example, the maximum number\n\t\t\tof records that you can create in the hosted zone.
\nFor the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/hostedzonelimit/{HostedZoneId}/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetHostedZoneLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#HostedZoneLimitType", - "traits": { - "smithy.api#documentation": "The limit that you want to get. Valid values include the following:
\n\n MAX_RRSETS_BY_ZONE: The maximum number of\n\t\t\t\t\trecords that you can create in the specified hosted zone.
\n\n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum\n\t\t\t\t\tnumber of Amazon VPCs that you can associate with the specified private hosted\n\t\t\t\t\tzone.
\nThe ID of the hosted zone that you want to get a limit for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the request to create a hosted\n\t\t\tzone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHostedZoneLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#HostedZoneLimit", - "traits": { - "smithy.api#documentation": "The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request,\n\t\t\tthe value of Limit is the maximum number of records that you can create in\n\t\t\tthe specified hosted zone.
The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_RRSETS_BY_ZONE for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of records that you have created in the specified hosted zone.
A complex type that contains the requested limit.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetHostedZoneRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the hosted zone that you want to get information about.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A request to get information about a specified hosted zone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetHostedZoneResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "A complex type that contains general information about the specified hosted\n\t\t\tzone.
", - "smithy.api#required": {} - } - }, - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "A complex type that lists the Amazon Route 53 name servers for the specified hosted\n\t\t\tzone.
" - } - }, - "VPCs": { - "target": "com.amazonaws.route53#VPCs", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the VPCs that are associated with the\n\t\t\tspecified hosted zone.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contain the response to a GetHostedZone\n\t\t\trequest.
Gets information about a specified configuration for DNS query logging.
\nFor more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS\n\t\t\tQueries.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/queryloggingconfig/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetQueryLoggingConfigRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "The ID of the configuration for DNS query logging that you want to get information\n\t\t\tabout.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetQueryLoggingConfigResponse": { - "type": "structure", - "members": { - "QueryLoggingConfig": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the query logging configuration that\n\t\t\tyou specified in a GetQueryLoggingConfig request.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetReusableDelegationSetRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetReusableDelegationSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#DelegationSetNotReusable" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a specified reusable delegation set, including the four\n\t\t\tname servers that are assigned to the delegation set.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/delegationset/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimit": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimitRequest" - }, - "output": { - "target": "com.amazonaws.route53#GetReusableDelegationSetLimitResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchDelegationSet" - } - ], - "traits": { - "smithy.api#documentation": "Gets the maximum number of hosted zones that you can associate with the specified\n\t\t\treusable delegation set.
\nFor the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/reusabledelegationsetlimit/{DelegationSetId}/{Type}", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimitRequest": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", - "traits": { - "smithy.api#documentation": "Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of\n\t\t\thosted zones that you can associate with the specified reusable delegation set.
The ID of the delegation set that you want to get the limit for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the request to create a hosted\n\t\t\tzone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSetLimitResponse": { - "type": "structure", - "members": { - "Limit": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimit", - "traits": { - "smithy.api#documentation": "The current setting for the limit on hosted zones that you can associate with the\n\t\t\tspecified reusable delegation set.
", - "smithy.api#required": {} - } - }, - "Count": { - "target": "com.amazonaws.route53#UsageCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The current number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the requested limit.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSetRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the reusable delegation set that you want to get a list of name servers\n\t\t\tfor.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A request to get information about a specified reusable delegation set.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetReusableDelegationSetResponse": { - "type": "structure", - "members": { - "DelegationSet": { - "target": "com.amazonaws.route53#DelegationSet", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the reusable delegation set.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response to the GetReusableDelegationSet\n\t\t\trequest.
Gets information about a specific traffic policy version.
\nFor information about how of deleting a traffic policy affects the response from\n\t\t\t\tGetTrafficPolicy, see DeleteTrafficPolicy.
Gets information about a specified traffic policy instance.
\n\n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.
In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nGets the number of traffic policy instances that are associated with the current\n\t\t\t\tAmazon Web Services account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/trafficpolicyinstancecount", - "code": 200 - } - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "Request to get the number of traffic policy instances that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstanceCount": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceCount", - "traits": { - "smithy.api#documentation": "The number of traffic policy instances that are associated with the current Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "The ID of the traffic policy instance that you want to get information about.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Gets information about a specified traffic policy instance.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the traffic policy instance.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "The ID of the traffic policy that you want to get information about.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version number of the traffic policy that you want to get information\n\t\t\tabout.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Gets information about a specific traffic policy version.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#GetTrafficPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the specified traffic policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#HealthCheck": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.
", - "smithy.api#required": {} - } - }, - "CallerReference": { - "target": "com.amazonaws.route53#HealthCheckNonce", - "traits": { - "smithy.api#documentation": "A unique string that you specified when you created the health check.
", - "smithy.api#required": {} - } - }, - "LinkedService": { - "target": "com.amazonaws.route53#LinkedService", - "traits": { - "smithy.api#documentation": "If the health check was created by another service, the service that created the\n\t\t\thealth check. When a health check is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.
" - } - }, - "HealthCheckConfig": { - "target": "com.amazonaws.route53#HealthCheckConfig", - "traits": { - "smithy.api#documentation": "A complex type that contains detailed information about one health check.
", - "smithy.api#required": {} - } - }, - "HealthCheckVersion": { - "target": "com.amazonaws.route53#HealthCheckVersion", - "traits": { - "smithy.api#documentation": "The version of the health check. You can optionally pass this value in a call to\n\t\t\t\tUpdateHealthCheck to prevent overwriting another change to the health\n\t\t\tcheck.
A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.
" - } - }, - "com.amazonaws.route53#HealthCheckAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The health check you're attempting to create already exists. Amazon Route 53 returns\n\t\t\tthis error when you submit a request that has the following values:
\nThe same value for CallerReference as an existing health check,\n\t\t\t\t\tand one or more values that differ from the existing health check that has the\n\t\t\t\t\tsame caller reference.
The same value for CallerReference as a health check that you\n\t\t\t\t\tcreated and later deleted, regardless of the other settings in the\n\t\t\t\t\trequest.
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address returned by DNS, Route 53 then\n\t\t\tchecks the health of the endpoint.
Use one of the following formats for the value of IPAddress:
\n IPv4 address: four values between 0 and 255,\n\t\t\t\t\tseparated by periods (.), for example, 192.0.2.44.
\n IPv6 address: eight groups of four\n\t\t\t\t\thexadecimal values, separated by colons (:), for example,\n\t\t\t\t\t\t2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten\n\t\t\t\t\tIPv6 addresses as described in RFC 5952, for example,\n\t\t\t\t\t\t2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance will never\n\t\t\tchange.
For more information, see FullyQualifiedDomainName.
\nConstraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:
\n\n RFC 6598, IANA-Reserved IPv4\n\t\t\t\t\t\tPrefix for Shared Address Space\n
\nWhen the value of Type is CALCULATED or\n\t\t\t\tCLOUDWATCH_METRIC, omit IPAddress.
The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.
\nDon't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.
The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.
\nYou can't change the value of Type after you create a health\n\t\t\t\tcheck.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTP request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTPS request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\nIf you specify HTTPS for the value of Type, the\n\t\t\t\t\t\tendpoint must support TLS v1.0 or later.
\n HTTP_STR_MATCH: Route 53 tries to establish a\n\t\t\t\t\tTCP connection. If successful, Route 53 submits an HTTP request and searches the\n\t\t\t\t\tfirst 5,120 bytes of the response body for the string that you specify in\n\t\t\t\t\t\tSearchString.
\n HTTPS_STR_MATCH: Route 53 tries to establish\n\t\t\t\t\ta TCP connection. If successful, Route 53 submits an HTTPS request\n\t\t\t\t\tand searches the first 5,120 bytes of the response body for the string that you\n\t\t\t\t\tspecify in SearchString.
\n TCP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection.
\n\n CLOUDWATCH_METRIC: The health check is\n\t\t\t\t\tassociated with a CloudWatch alarm. If the state of the alarm is\n\t\t\t\t\tOK, the health check is considered healthy. If the state is\n\t\t\t\t\t\tALARM, the health check is considered unhealthy. If CloudWatch\n\t\t\t\t\tdoesn't have sufficient data to determine whether the state is OK\n\t\t\t\t\tor ALARM, the health check status depends on the setting for\n\t\t\t\t\t\tInsufficientDataHealthStatus: Healthy,\n\t\t\t\t\t\tUnhealthy, or LastKnownStatus.
\n CALCULATED: For health checks that monitor\n\t\t\t\t\tthe status of other health checks, Route 53 adds up the number of health checks\n\t\t\t\t\tthat Route 53 health checkers consider to be healthy and compares that number\n\t\t\t\t\twith the value of HealthThreshold.
\n RECOVERY_CONTROL: The health check is\n\t\t\t\t\tassocated with a Route53 Application Recovery Controller routing control. If the\n\t\t\t\t\trouting control state is ON, the health check is considered\n\t\t\t\t\thealthy. If the state is OFF, the health check is considered\n\t\t\t\t\tunhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
", - "smithy.api#required": {} - } - }, - "ResourcePath": { - "target": "com.amazonaws.route53#ResourcePath", - "traits": { - "smithy.api#documentation": "The path, if any, that you want Amazon Route 53 to request when performing health\n\t\t\tchecks. The path can be any value for which your endpoint will return an HTTP status\n\t\t\tcode of 2xx or 3xx when the endpoint is healthy, for example, the file\n\t\t\t/docs/route53-health-check.html. You can also include query string parameters, for\n\t\t\texample, /welcome.html?language=jp&login=y.
Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.
\n If you specify a value for\n IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and\n\t\t\tpasses the value of FullyQualifiedDomainName in the Host\n\t\t\theader for all health checks except TCP health checks. This is typically the fully\n\t\t\tqualified DNS name of the endpoint on which you want Route 53 to perform health\n\t\t\tchecks.
When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:
If you specify a value of 80 for Port and\n\t\t\t\t\t\tHTTP or HTTP_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify a value of 443 for Port and\n\t\t\t\t\t\tHTTPS or HTTPS_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify another value for Port and any value except\n\t\t\t\t\t\tTCP for Type, Route 53 passes\n\t\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the\n\t\t\t\t\t\tHost header.
If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the preceding cases.
\n If you don't specify a value for\n IPAddress:
Route 53 sends a DNS request to the domain that you specify for\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify for\n\t\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then\n\t\t\tchecks the health of the endpoint.
If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.
If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record sets\n\t\t\t(www.example.com).
In this configuration, if you create a health check for which the value of\n\t\t\t\t\tFullyQualifiedDomainName matches the name of the resource record\n\t\t\t\tsets and you then associate the health check with those resource record sets, health\n\t\t\t\tcheck results will be unpredictable.
In addition, if the value that you specify for Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.
If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH,\n\t\t\tthe string that you want Amazon Route 53 to search for in the response body from the\n\t\t\tspecified resource. If the string appears in the response body, Route 53 considers the\n\t\t\tresource healthy.
Route 53 considers case when searching for SearchString in the response\n\t\t\tbody.
The number of seconds between the time that Amazon Route 53 gets a response from your\n\t\t\tendpoint and the time that it sends the next health check request. Each Route 53 health\n\t\t\tchecker makes requests at this interval.
\nYou can't change the value of RequestInterval after you create a\n\t\t\t\thealth check.
If you don't specify a value for RequestInterval, the default value is\n\t\t\t\t30 seconds.
The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.
Specify whether you want Amazon Route 53 to measure the latency between health\n\t\t\tcheckers in multiple Amazon Web Services regions and your endpoint, and to display\n\t\t\tCloudWatch latency graphs on the Health Checks page in\n\t\t\tthe Route 53 console.
\nYou can't change the value of MeasureLatency after you create a\n\t\t\t\thealth check.
Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.
" - } - }, - "Disabled": { - "target": "com.amazonaws.route53#Disabled", - "traits": { - "smithy.api#documentation": "Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:
\n\n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.
\n\n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.
\n\n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.
\nAfter you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.
\nCharges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.
" - } - }, - "HealthThreshold": { - "target": "com.amazonaws.route53#HealthThreshold", - "traits": { - "smithy.api#documentation": "The number of child health checks that are associated with a CALCULATED\n\t\t\thealth check that Amazon Route 53 must consider healthy for the CALCULATED\n\t\t\thealth check to be considered healthy. To specify the child health checks that you want\n\t\t\tto associate with a CALCULATED health check, use the ChildHealthChecks element.
Note the following:
\nIf you specify a number greater than the number of child health checks, Route\n\t\t\t\t\t53 always considers this health check to be unhealthy.
\nIf you specify 0, Route 53 always considers this health check to\n\t\t\t\t\tbe healthy.
(CALCULATED Health Checks Only) A complex type that contains one\n\t\t\t\tChildHealthCheck element for each health check that you want to\n\t\t\tassociate with a CALCULATED health check.
Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows the endpoint\n\t\t\tto respond to HTTPS health check requests with the applicable SSL/TLS\n\t\t\tcertificate.
Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.
A complex type that contains one Region element for each region from\n\t\t\twhich you want Amazon Route 53 health checkers to check the specified endpoint.
If you don't specify any regions, Route 53 health checkers automatically performs\n\t\t\tchecks from all of the regions that are listed under Valid\n\t\t\t\tValues.
\nIf you update a health check to remove a region that has been performing health\n\t\t\tchecks, Route 53 will briefly continue to perform checks from that region to ensure that\n\t\t\tsome health checkers are always checking the endpoint (for example, if you replace three\n\t\t\tregions with four different regions).
" - } - }, - "AlarmIdentifier": { - "target": "com.amazonaws.route53#AlarmIdentifier", - "traits": { - "smithy.api#documentation": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.
" - } - }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", - "traits": { - "smithy.api#documentation": "When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:
\n\n Healthy: Route 53 considers the health check to be\n\t\t\t\t\thealthy.
\n Unhealthy: Route 53 considers the health check to be\n\t\t\t\t\tunhealthy.
\n LastKnownStatus: Route 53 uses the status of the health check\n\t\t\t\t\tfrom the last time that CloudWatch had sufficient data to determine the alarm\n\t\t\t\t\tstate. For new health checks that have no last known status, the default status\n\t\t\t\t\tfor the health check is healthy.
The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\n\t\t\trouting control.
\nFor more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the health check.
" - } - }, - "com.amazonaws.route53#HealthCheckCount": { - "type": "long" - }, - "com.amazonaws.route53#HealthCheckId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "This error code is not in use.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#HealthCheckNonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckObservation": { - "type": "structure", - "members": { - "Region": { - "target": "com.amazonaws.route53#HealthCheckRegion", - "traits": { - "smithy.api#documentation": "The region of the Amazon Route 53 health checker that provided the status in\n\t\t\t\tStatusReport.
The IP address of the Amazon Route 53 health checker that provided the failure reason\n\t\t\tin StatusReport.
A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker and the time of the failed health check.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker.
" - } - }, - "com.amazonaws.route53#HealthCheckObservations": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckObservation", - "traits": { - "smithy.api#xmlName": "HealthCheckObservation" - } - } - }, - "com.amazonaws.route53#HealthCheckRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckRegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HealthCheckRegion", - "traits": { - "smithy.api#xmlName": "Region" - } - }, - "traits": { - "smithy.api#length": { - "min": 3, - "max": 64 - } - } - }, - "com.amazonaws.route53#HealthCheckType": { - "type": "enum", - "members": { - "HTTP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP" - } - }, - "HTTPS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS" - } - }, - "HTTP_STR_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTP_STR_MATCH" - } - }, - "HTTPS_STR_MATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HTTPS_STR_MATCH" - } - }, - "TCP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TCP" - } - }, - "CALCULATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CALCULATED" - } - }, - "CLOUDWATCH_METRIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDWATCH_METRIC" - } - }, - "RECOVERY_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RECOVERY_CONTROL" - } - } - } - }, - "com.amazonaws.route53#HealthCheckVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#HealthCheckVersionMismatch": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The value of HealthCheckVersion in the request doesn't match the value of\n\t\t\t\tHealthCheckVersion in the health check.
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.
\nFor information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see CreateHostedZone.
The value that you specified for CallerReference when you created the\n\t\t\thosted zone.
A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment\n\t\t\telements from the request, the Config and Comment elements\n\t\t\tdon't appear in the response.
The number of resource record sets in the hosted zone.
" - } - }, - "LinkedService": { - "target": "com.amazonaws.route53#LinkedService", - "traits": { - "smithy.api#documentation": "If the hosted zone was created by another service, the service that created the hosted\n\t\t\tzone. When a hosted zone is created by another service, you can't edit or delete it\n\t\t\tusing Route 53.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
" - } - }, - "com.amazonaws.route53#HostedZoneAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The hosted zone you're trying to create already exists. Amazon Route 53 returns this\n\t\t\terror when a hosted zone has already been created with the specified\n\t\t\t\tCallerReference.
Any comments that you want to include about the hosted zone.
" - } - }, - "PrivateZone": { - "target": "com.amazonaws.route53#IsPrivateZone", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A value that indicates whether this is a private hosted zone.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\t\tComment elements.
The limit that you requested. Valid values include the following:
\n\n MAX_RRSETS_BY_ZONE: The maximum number of\n\t\t\t\t\trecords that you can create in the specified hosted zone.
\n\n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum\n\t\t\t\t\tnumber of Amazon VPCs that you can associate with the specified private hosted\n\t\t\t\t\tzone.
\nThe current value for the limit that is specified by Type.
A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.
" - } - }, - "com.amazonaws.route53#HostedZoneLimitType": { - "type": "enum", - "members": { - "MAX_RRSETS_BY_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_RRSETS_BY_ZONE" - } - }, - "MAX_VPCS_ASSOCIATED_BY_ZONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_VPCS_ASSOCIATED_BY_ZONE" - } - } - } - }, - "com.amazonaws.route53#HostedZoneNotEmpty": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The hosted zone contains resource records that are not SOA or NS records.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#HostedZoneNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified HostedZone can't be found.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneNotPrivate": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified hosted zone is a public hosted zone, not a private hosted zone.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneOwner": { - "type": "structure", - "members": { - "OwningAccount": { - "target": "com.amazonaws.route53#AWSAccountID", - "traits": { - "smithy.api#documentation": "If the hosted zone was created by an Amazon Web Services account, or was created by an\n\t\t\t\tAmazon Web Services service that creates hosted zones using the current account,\n\t\t\t\tOwningAccount contains the account ID of that account. For example,\n\t\t\twhen you use Cloud Map to create a hosted zone, Cloud Map creates the hosted\n\t\t\tzone using the current Amazon Web Services account.
If an Amazon Web Services service uses its own account to create a hosted zone and\n\t\t\tassociate the specified VPC with that hosted zone, OwningService contains\n\t\t\tan abbreviation that identifies the service. For example, if Amazon Elastic File System\n\t\t\t(Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value\n\t\t\tof OwningService is efs.amazonaws.com.
A complex type that identifies a hosted zone that a specified Amazon VPC is associated\n\t\t\twith and the owner of the hosted zone. If there is a value for\n\t\t\t\tOwningAccount, there is no value for OwningService, and\n\t\t\tvice versa.
The hosted zone nameservers don't match the parent nameservers. The hosted zone and\n\t\t\tparent must have the same nameservers.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#HostedZoneRRSetCount": { - "type": "long" - }, - "com.amazonaws.route53#HostedZoneSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#HostedZoneSummary", - "traits": { - "smithy.api#xmlName": "HostedZoneSummary" - } - } - }, - "com.amazonaws.route53#HostedZoneSummary": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The Route 53 hosted zone ID of a private hosted zone that the specified VPC is\n\t\t\tassociated with.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "The name of the private hosted zone, such as example.com.
The owner of a private hosted zone that the specified VPC is associated with. The\n\t\t\towner can be either an Amazon Web Services account or an Amazon Web Services\n\t\t\tservice.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.
The resource you're trying to access is unsupported on this Amazon Route 53\n\t\t\tendpoint.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "Amazon Route 53 doesn't have the permissions required to create log streams and send\n\t\t\tquery logs to log streams. Possible causes include the following:
\nThere is no resource policy that specifies the log group ARN in the value for\n\t\t\t\t\t\tResource.
The resource policy that includes the log group ARN in the value for\n\t\t\t\t\t\tResource doesn't have the necessary permissions.
The resource policy hasn't finished propagating yet.
\nThe Key management service (KMS) key you specified doesn’t exist or it can’t\n\t\t\t\t\tbe used with the log group associated with query log. Update or provide a\n\t\t\t\t\tresource policy to grant permissions for the KMS key.
\nThe Key management service (KMS) key you specified is marked as \n\t\t\t\tdisabled for the log group associated with query log. Update or provide \n\t\t\t\ta resource policy to grant permissions for the KMS key.
\nParameter name is not valid.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidChangeBatch": { - "type": "structure", - "members": { - "messages": { - "target": "com.amazonaws.route53#ErrorMessages", - "traits": { - "smithy.api#documentation": "" - } - }, - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "This exception contains a list of messages that might contain one or more error\n\t\t\tmessages. Each error message indicates one error in the change batch.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidDomainName": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified domain name is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidInput": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The input is not valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidKMSArn": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC\n\t\t\tsigning.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#InvalidKeySigningKeyName": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The key-signing key (KSK) name that you specified isn't a valid name.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidKeySigningKeyStatus": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The key-signing key (KSK) status isn't valid or another KSK has the status\n\t\t\t\tINTERNAL_FAILURE.
The value that you specified to get the second or subsequent page of results is\n\t\t\tinvalid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#InvalidSigningStatus": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "Your hosted zone status isn't valid for this operation. In the hosted zone, change the\n\t\t\tstatus to enable DNSSEC or disable DNSSEC.
The format of the traffic policy document that you specified in the\n\t\t\t\tDocument element is not valid.
The VPC ID that you specified either isn't a valid ID or the current account is not\n\t\t\tauthorized to access this VPC.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#Inverted": { - "type": "boolean" - }, - "com.amazonaws.route53#IsPrivateZone": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#KeySigningKey": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.route53#SigningKeyName", - "traits": { - "smithy.api#documentation": "A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each\n\t\t\tkey-signing key (KSK) in a single hosted zone.
You must configure the customer managed key as follows:
\nEnabled
\nECC_NIST_P256
\nSign and verify
\nThe key policy must give permission for the following actions:
\nDescribeKey
\nGetPublicKey
\nSign
\nThe key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:
\n\n \"Service\": \"dnssec-route53.amazonaws.com\"\n
For more information about working with the customer managed key in KMS, see Key Management Service\n\t\t\t\tconcepts.
" - } - }, - "Flag": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "An integer that specifies how the key is used. For key-signing key (KSK), this value\n\t\t\tis always 257.
" - } - }, - "SigningAlgorithmMnemonic": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "A string used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.
" - } - }, - "SigningAlgorithmType": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "An integer used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.
" - } - }, - "DigestAlgorithmMnemonic": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "A string used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section 3.3.\n\t\t
" - } - }, - "DigestAlgorithmType": { - "target": "com.amazonaws.route53#SigningKeyInteger", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "An integer used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section\n\t\t\t3.3.
" - } - }, - "KeyTag": { - "target": "com.amazonaws.route53#SigningKeyTag", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "An integer used to identify the DNSSEC record for the domain name. The process used to\n\t\t\tcalculate the value is described in RFC-4034 Appendix B.
" - } - }, - "DigestValue": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to\n\t\t\tpublish the public key that resolvers can use to verify DNSSEC signatures that are used\n\t\t\tto secure certain kinds of information provided by the DNS system.
" - } - }, - "PublicKey": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
" - } - }, - "DSRecord": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "A string that represents a delegation signer (DS) record.
" - } - }, - "DNSKEYRecord": { - "target": "com.amazonaws.route53#SigningKeyString", - "traits": { - "smithy.api#documentation": "A string that represents a DNSKEY record.
" - } - }, - "Status": { - "target": "com.amazonaws.route53#SigningKeyStatus", - "traits": { - "smithy.api#documentation": "A string that represents the current key-signing key (KSK) status.
\nStatus can have one of the following values:
\nThe KSK is being used for signing.
\nThe KSK is not being used for signing.
\nThe KSK is in the process of being deleted.
\nThere is a problem with the KSK that requires you to take action to\n\t\t\t\t\t\tresolve. For example, the customer managed key might have been deleted,\n\t\t\t\t\t\tor the permissions for the customer managed key might have been\n\t\t\t\t\t\tchanged.
\nThere was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including actions that involve this KSK, you must correct\n\t\t\t\t\t\tthe problem. For example, you may need to activate or deactivate the\n\t\t\t\t\t\tKSK.
\nThe status message provided for the following key-signing key (KSK) statuses:\n\t\t\t\tACTION_NEEDED or INTERNAL_FAILURE. The status message\n\t\t\tincludes information about what the problem might be and steps that you can take to\n\t\t\tcorrect the issue.
The date when the key-signing key (KSK) was created.
" - } - }, - "LastModifiedDate": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "The last time that the key-signing key (KSK) was changed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A key-signing key (KSK) is a complex type that represents a public/private key pair.\n\t\t\tThe private key is used to generate a digital signature for the zone signing key (ZSK).\n\t\t\tThe public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always\n\t\t\tassociated with a hosted zone; it cannot exist by itself.
" - } - }, - "com.amazonaws.route53#KeySigningKeyAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#KeySigningKeyInParentDSRecord": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The key-signing key (KSK) is specified in a parent DS record.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#KeySigningKeyInUse": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The key-signing key (KSK) that you specified can't be deactivated because it's the\n\t\t\tonly KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable\n\t\t\tanother KSK.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "A key-signing key (KSK) with ACTIVE status wasn't found.
The VPC that you're trying to disassociate from the private hosted zone is the last\n\t\t\tVPC that is associated with the hosted zone. Amazon Route 53 doesn't support\n\t\t\tdisassociating the last VPC from a hosted zone.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#LimitValue": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.route53#LimitsExceeded": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "This operation can't be completed because the current account has reached the\n\t\t\tlimit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#LinkedService": { - "type": "structure", - "members": { - "ServicePrincipal": { - "target": "com.amazonaws.route53#ServicePrincipal", - "traits": { - "smithy.api#documentation": "If the health check or hosted zone was created by another service, the service that\n\t\t\tcreated the resource. When a resource is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.
" - } - }, - "Description": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "If the health check or hosted zone was created by another service, an optional\n\t\t\tdescription that can be provided by the other service. When a resource is created by\n\t\t\tanother service, you can't edit or delete it using Amazon Route 53.
" - } - } - }, - "traits": { - "smithy.api#documentation": "If a health check or hosted zone was created by another service,\n\t\t\t\tLinkedService is a complex type that describes the service that created\n\t\t\tthe resource. When a resource is created by another service, you can't edit or delete it\n\t\t\tusing Amazon Route 53.
Returns a paginated list of location objects and their CIDR blocks.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection/{CollectionId}/cidrblocks", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrBlocks", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrBlocksRequest": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "The UUID of the CIDR collection.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", - "traits": { - "smithy.api#documentation": "The name of the CIDR collection location.
", - "smithy.api#httpQuery": "location" - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "Maximum number of results you want returned.
", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListCidrBlocksResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
" - } - }, - "CidrBlocks": { - "target": "com.amazonaws.route53#CidrBlockSummaries", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the CIDR blocks.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListCidrCollections": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrCollectionsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrCollectionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "Returns a paginated list of CIDR collections in the Amazon Web Services account\n\t\t\t(metadata only).
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrCollections", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrCollectionsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of CIDR collections to return in the response.
", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListCidrCollectionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
" - } - }, - "CidrCollections": { - "target": "com.amazonaws.route53#CollectionSummaries", - "traits": { - "smithy.api#documentation": "A complex type with information about the CIDR collection.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListCidrLocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListCidrLocationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListCidrLocationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchCidrCollectionException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a paginated list of CIDR locations for the given collection (metadata only,\n\t\t\tdoes not include CIDR blocks).
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/cidrcollection/{CollectionId}", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "CidrLocations", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListCidrLocationsRequest": { - "type": "structure", - "members": { - "CollectionId": { - "target": "com.amazonaws.route53#UUID", - "traits": { - "smithy.api#documentation": "The CIDR collection ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
", - "smithy.api#httpQuery": "nexttoken" - } - }, - "MaxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of CIDR collection locations to return in the response.
", - "smithy.api#httpQuery": "maxresults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListCidrLocationsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
" - } - }, - "CidrLocations": { - "target": "com.amazonaws.route53#LocationSummaries", - "traits": { - "smithy.api#documentation": "A complex type that contains information about the list of CIDR locations.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListGeoLocations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListGeoLocationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListGeoLocationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list of supported geographic locations.
\nCountries are listed first, and continents are listed last. If Amazon Route 53\n\t\t\tsupports subdivisions for a country (for example, states or provinces), the subdivisions\n\t\t\tfor that country are listed in alphabetical order immediately after the corresponding\n\t\t\tcountry.
\nRoute 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.
\nFor a list of supported geolocation codes, see the GeoLocation data\n\t\t\ttype.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/geolocations", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListGeoLocationsRequest": { - "type": "structure", - "members": { - "StartContinentCode": { - "target": "com.amazonaws.route53#GeoLocationContinentCode", - "traits": { - "smithy.api#documentation": "The code for the continent with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if NextContinentCode from\n\t\t\tthe previous response has a value, enter that value in startcontinentcode\n\t\t\tto return the next page of results.
Include startcontinentcode only if you want to list continents. Don't\n\t\t\tinclude startcontinentcode when you're listing countries or countries with\n\t\t\ttheir subdivisions.
The code for the country with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if\n\t\t\t\tNextCountryCode from the previous response has a value, enter that\n\t\t\tvalue in startcountrycode to return the next page of results.
The code for the state of the United States with which you want to start listing\n\t\t\tlocations that Amazon Route 53 supports for geolocation. If Route 53 has already\n\t\t\treturned a page or more of results, if IsTruncated is true,\n\t\t\tand if NextSubdivisionCode from the previous response has a value, enter\n\t\t\tthat value in startsubdivisioncode to return the next page of\n\t\t\tresults.
To list subdivisions (U.S. states), you must include both\n\t\t\t\tstartcountrycode and startsubdivisioncode.
(Optional) The maximum number of geolocations to be included in the response body for\n\t\t\tthis request. If more than maxitems geolocations remain to be listed, then\n\t\t\tthe value of the IsTruncated element in the response is\n\t\t\ttrue.
A request to get a list of geographic locations that Amazon Route 53 supports for\n\t\t\tgeolocation resource record sets.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListGeoLocationsResponse": { - "type": "structure", - "members": { - "GeoLocationDetailsList": { - "target": "com.amazonaws.route53#GeoLocationDetailsList", - "traits": { - "smithy.api#documentation": "A complex type that contains one GeoLocationDetails element for each\n\t\t\tlocation that Amazon Route 53 supports for geolocation.
A value that indicates whether more locations remain to be listed after the last\n\t\t\tlocation in this response. If so, the value of IsTruncated is\n\t\t\t\ttrue. To get more values, submit another request and include the values\n\t\t\tof NextContinentCode, NextCountryCode, and\n\t\t\t\tNextSubdivisionCode in the startcontinentcode,\n\t\t\t\tstartcountrycode, and startsubdivisioncode, as\n\t\t\tapplicable.
If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextContinentCode in the\n\t\t\t\tstartcontinentcode parameter in another ListGeoLocations\n\t\t\trequest.
If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextCountryCode in the\n\t\t\t\tstartcountrycode parameter in another ListGeoLocations\n\t\t\trequest.
If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextSubdivisionCode in the\n\t\t\t\tstartsubdivisioncode parameter in another ListGeoLocations\n\t\t\trequest.
The value that you specified for MaxItems in the request.
A complex type containing the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListHealthChecks": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHealthChecksRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHealthChecksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#IncompatibleVersion" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/healthcheck", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "Marker", - "outputToken": "NextMarker", - "items": "HealthChecks", - "pageSize": "MaxItems" - } - } - }, - "com.amazonaws.route53#ListHealthChecksRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more health checks. To get another group, submit another\n\t\t\t\tListHealthChecks request.
For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first health check that Amazon Route\n\t\t\t53 will return if you submit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more health checks to get.
The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 1000\n\t\t\titems. If you set MaxItems to a value greater than 1000, Route 53 returns\n\t\t\tonly the first 1000 health checks.
A request to retrieve a list of the health checks that are associated with the current\n\t\t\t\tAmazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHealthChecksResponse": { - "type": "structure", - "members": { - "HealthChecks": { - "target": "com.amazonaws.route53#HealthChecks", - "traits": { - "smithy.api#documentation": "A complex type that contains one HealthCheck element for each health\n\t\t\tcheck that is associated with the current Amazon Web Services account.
For the second and subsequent calls to ListHealthChecks,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the previous request.
A flag that indicates whether there are more health checks to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of health checks by submitting\n\t\t\tanother ListHealthChecks request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.
If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first health check that Amazon Route 53 returns if you submit another\n\t\t\t\tListHealthChecks request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHealthChecks that produced the current response.
A complex type that contains the response to a ListHealthChecks\n\t\t\trequest.
Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account. The response includes a HostedZones\n\t\t\tchild element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of\n\t\t\thosted zones, you can use the maxitems parameter to list them in groups of\n\t\t\tup to 100.
Retrieves a list of your hosted zones in lexicographic order. The response includes a\n\t\t\t\tHostedZones child element for each hosted zone created by the current\n\t\t\t\tAmazon Web Services account.
\n ListHostedZonesByName sorts hosted zones by name with the labels\n\t\t\treversed. For example:
\n com.example.www.\n
Note the trailing dot, which can change the sort order in some circumstances.
\nIf the domain name includes escape characters or Punycode,\n\t\t\t\tListHostedZonesByName alphabetizes the domain name using the escaped or\n\t\t\tPunycoded value, which is the format that Amazon Route 53 saves in its database. For\n\t\t\texample, to create a hosted zone for exämple.com, you specify ex\\344mple.com for\n\t\t\tthe domain name. ListHostedZonesByName alphabetizes it as:
\n com.ex\\344mple.\n
The labels are reversed and alphabetized using the escaped value. For more information\n\t\t\tabout valid domain name formats, including internationalized domain names, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nRoute 53 returns up to 100 items in each response. If you have a lot of hosted zones,\n\t\t\tuse the MaxItems parameter to list them in groups of up to 100. The\n\t\t\tresponse includes values that help navigate from one group of MaxItems\n\t\t\thosted zones to the next:
The DNSName and HostedZoneId elements in the\n\t\t\t\t\tresponse contain the values, if any, specified for the dnsname and\n\t\t\t\t\t\thostedzoneid parameters in the request that produced the\n\t\t\t\t\tcurrent response.
The MaxItems element in the response contains the value, if any,\n\t\t\t\t\tthat you specified for the maxitems parameter in the request that\n\t\t\t\t\tproduced the current response.
If the value of IsTruncated in the response is true, there are\n\t\t\t\t\tmore hosted zones associated with the current Amazon Web Services account.
If IsTruncated is false, this response includes the last hosted\n\t\t\t\t\tzone that is associated with the current account. The NextDNSName\n\t\t\t\t\telement and NextHostedZoneId elements are omitted from the\n\t\t\t\t\tresponse.
The NextDNSName and NextHostedZoneId elements in the\n\t\t\t\t\tresponse contain the domain name and the hosted zone ID of the next hosted zone\n\t\t\t\t\tthat is associated with the current Amazon Web Services account. If you want to\n\t\t\t\t\tlist more hosted zones, make another call to ListHostedZonesByName,\n\t\t\t\t\tand specify the value of NextDNSName and\n\t\t\t\t\t\tNextHostedZoneId in the dnsname and\n\t\t\t\t\t\thostedzoneid parameters, respectively.
(Optional) For your first request to ListHostedZonesByName, include the\n\t\t\t\tdnsname parameter only if you want to specify the name of the first\n\t\t\thosted zone in the response. If you don't include the dnsname parameter,\n\t\t\tAmazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both\n\t\t\t\tdnsname and hostedzoneid parameters. For\n\t\t\t\tdnsname, specify the value of NextDNSName from the\n\t\t\tprevious response.
(Optional) For your first request to ListHostedZonesByName, do not\n\t\t\tinclude the hostedzoneid parameter.
If you have more hosted zones than the value of maxitems,\n\t\t\t\tListHostedZonesByName returns only the first maxitems\n\t\t\thosted zones. To get the next group of maxitems hosted zones, submit\n\t\t\tanother request to ListHostedZonesByName and include both\n\t\t\t\tdnsname and hostedzoneid parameters. For the value of\n\t\t\t\thostedzoneid, specify the value of the NextHostedZoneId\n\t\t\telement from the previous response.
The maximum number of hosted zones to be included in the response body for this\n\t\t\trequest. If you have more than maxitems hosted zones, then the value of the\n\t\t\t\tIsTruncated element in the response is true, and the values of\n\t\t\t\tNextDNSName and NextHostedZoneId specify the first hosted\n\t\t\tzone in the next group of maxitems hosted zones.
Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account in ASCII order by domain name.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHostedZonesByNameResponse": { - "type": "structure", - "members": { - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", - "traits": { - "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
", - "smithy.api#required": {} - } - }, - "DNSName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "For the second and subsequent calls to ListHostedZonesByName,\n\t\t\t\tDNSName is the value that you specified for the dnsname\n\t\t\tparameter in the request that produced the current response.
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
" - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A flag that indicates whether there are more hosted zones to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of maxitems hosted zones\n\t\t\tby calling ListHostedZonesByName again and specifying the values of\n\t\t\t\tNextDNSName and NextHostedZoneId elements in the\n\t\t\t\tdnsname and hostedzoneid parameters.
If IsTruncated is true, the value of NextDNSName is the name\n\t\t\tof the first hosted zone in the next group of maxitems hosted zones. Call\n\t\t\t\tListHostedZonesByName again and specify the value of\n\t\t\t\tNextDNSName and NextHostedZoneId in the\n\t\t\t\tdnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
If IsTruncated is true, the value of\n\t\t\t\tNextHostedZoneId identifies the first hosted zone in the next group of\n\t\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again\n\t\t\tand specify the value of NextDNSName and NextHostedZoneId in\n\t\t\tthe dnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZonesByName that produced the current response.
A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListHostedZonesByVPC": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListHostedZonesByVPCRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListHostedZonesByVPCResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - } - ], - "traits": { - "smithy.api#documentation": "Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:
An OwningAccount element, which contains the account number of\n\t\t\t\t\teither the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create\n\t\t\t\t\thosted zones using the current account.
An OwningService element, which identifies the Amazon Web Services\n\t\t\t\t\tservice that created and owns the hosted zone. For example, if a hosted zone was\n\t\t\t\t\tcreated by Amazon Elastic File System (Amazon EFS), the value of\n\t\t\t\t\t\tOwner is efs.amazonaws.com.
When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe ID of the Amazon VPC that you want to list hosted zones for.
", - "smithy.api#httpQuery": "vpcid", - "smithy.api#required": {} - } - }, - "VPCRegion": { - "target": "com.amazonaws.route53#VPCRegion", - "traits": { - "smithy.api#documentation": "For the Amazon VPC that you specified for VPCId, the Amazon Web Services\n\t\t\tRegion that you created the VPC in.
(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf the specified VPC is associated with more than MaxItems hosted zones,\n\t\t\tthe response includes a NextToken element. NextToken contains\n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if\n\t\t\tyou submit another request.
If the previous response included a NextToken element, the specified VPC\n\t\t\tis associated with more hosted zones. To get more hosted zones, submit another\n\t\t\t\tListHostedZonesByVPC request.
For the value of NextToken, specify the value of NextToken\n\t\t\tfrom the previous response.
If the previous response didn't include a NextToken element, there are no\n\t\t\tmore hosted zones to get.
Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account created the hosted zones.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHostedZonesByVPCResponse": { - "type": "structure", - "members": { - "HostedZoneSummaries": { - "target": "com.amazonaws.route53#HostedZoneSummaries", - "traits": { - "smithy.api#documentation": "A list that contains one HostedZoneSummary element for each hosted zone\n\t\t\tthat the specified Amazon VPC is associated with. Each HostedZoneSummary\n\t\t\telement contains the hosted zone name and ID, and information about who owns the hosted\n\t\t\tzone.
The value that you specified for MaxItems in the most recent\n\t\t\t\tListHostedZonesByVPC request.
The value that you will use for NextToken in the next\n\t\t\t\tListHostedZonesByVPC request.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more hosted zones. To get more hosted zones, submit\n\t\t\tanother ListHostedZones request.
For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first hosted zone that Amazon Route\n\t\t\t53 will return if you submit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more hosted zones to get.
(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf you have more than maxitems hosted zones, the value of\n\t\t\t\tIsTruncated in the response is true, and the value of\n\t\t\t\tNextMarker is the hosted zone ID of the first hosted zone that Route 53\n\t\t\twill return if you submit another request.
If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.
", - "smithy.api#httpQuery": "delegationsetid" - } - }, - "HostedZoneType": { - "target": "com.amazonaws.route53#HostedZoneType", - "traits": { - "smithy.api#documentation": "\n\t\t\t(Optional) Specifies if the hosted zone is private.\n\t\t
", - "smithy.api#httpQuery": "hostedzonetype" - } - } - }, - "traits": { - "smithy.api#documentation": "A request to retrieve a list of the public and private hosted zones that are\n\t\t\tassociated with the current Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListHostedZonesResponse": { - "type": "structure", - "members": { - "HostedZones": { - "target": "com.amazonaws.route53#HostedZones", - "traits": { - "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
", - "smithy.api#required": {} - } - }, - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "For the second and subsequent calls to ListHostedZones,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.
A flag indicating whether there are more hosted zones to be listed. If the response\n\t\t\twas truncated, you can get more hosted zones by submitting another\n\t\t\t\tListHostedZones request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.
If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first hosted zone in the next group of hosted zones. Submit another\n\t\t\t\tListHostedZones request, and specify the value of\n\t\t\t\tNextMarker from the response in the marker\n\t\t\tparameter.
This element is present only if IsTruncated is true.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZones that produced the current response.
Lists the configurations for DNS query logging that are associated with the current\n\t\t\t\tAmazon Web Services account or the configuration that is associated with a specified\n\t\t\thosted zone.
\nFor more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of\n\t\t\tDNS query logs, appears in Logging DNS Queries in\n\t\t\tthe Amazon Route 53 Developer Guide.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/queryloggingconfig", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "QueryLoggingConfigs", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.route53#ListQueryLoggingConfigsRequest": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "(Optional) If you want to list the query logging configuration that is associated with\n\t\t\ta hosted zone, specify the ID in HostedZoneId.
If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns\n\t\t\tall of the configurations that are associated with the current Amazon Web Services account.
(Optional) If the current Amazon Web Services account has more than\n\t\t\t\tMaxResults query logging configurations, use NextToken to\n\t\t\tget the second and subsequent pages of results.
For the first ListQueryLoggingConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from\n\t\t\tthe previous response and specify that value for NextToken in the\n\t\t\trequest.
(Optional) The maximum number of query logging configurations that you want Amazon\n\t\t\tRoute 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the\n\t\t\tvalue of NextToken in the response to get the next page of results.
If you don't specify a value for MaxResults, Route 53 returns up to 100\n\t\t\tconfigurations.
An array that contains one QueryLoggingConfig element for each configuration for DNS query logging\n\t\t\tthat is associated with the current Amazon Web Services account.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "If a response includes the last of the query logging configurations that are\n\t\t\tassociated with the current Amazon Web Services account, NextToken doesn't\n\t\t\tappear in the response.
If a response doesn't include the last of the configurations, you can get more\n\t\t\tconfigurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken\n\t\t\tthat Amazon Route 53 returned in the previous response and include it in\n\t\t\t\tNextToken in the next request.
Lists the resource record sets in a specified hosted zone.
\n\n ListResourceRecordSets returns up to 300 resource record sets at a time\n\t\t\tin ASCII order, beginning at a position specified by the name and\n\t\t\t\ttype elements.
\n Sort order\n
\n\n ListResourceRecordSets sorts results first by DNS name with the labels\n\t\t\treversed, for example:
\n com.example.www.\n
Note the trailing dot, which can change the sort order when the record name contains\n\t\t\tcharacters that appear before . (decimal 46) in the ASCII table. These\n\t\t\tcharacters include the following: ! \" # $ % & ' ( ) * + , -\n
When multiple records have the same DNS name, ListResourceRecordSets\n\t\t\tsorts results by the record type.
\n Specifying where to start listing records\n
\nYou can use the name and type elements to specify the resource record set that the\n\t\t\tlist begins with:
\nThe results begin with the first resource record set that the hosted zone\n\t\t\t\t\t\tcontains.
\nThe results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name.
Amazon Route 53 returns the InvalidInput error.
The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name, and whose type is\n\t\t\t\t\t\tgreater than or equal to Type.
\n Resource record sets that are PENDING\n
\nThis action returns the most current version of the records. This includes records\n\t\t\tthat are PENDING, and that are not yet available on all Route 53 DNS\n\t\t\tservers.
\n Changing resource record sets\n
\nTo ensure that you get an accurate listing of the resource record sets for a hosted\n\t\t\tzone at a point in time, do not submit a ChangeResourceRecordSets request\n\t\t\twhile you're paging through the results of a ListResourceRecordSets\n\t\t\trequest. If you do, some pages may display results without the latest changes while\n\t\t\tother pages display results with the latest changes.
\n Displaying the next page of results\n
\nIf a ListResourceRecordSets command returns more than one page of\n\t\t\tresults, the value of IsTruncated is true. To display the next\n\t\t\tpage of results, get the values of NextRecordName,\n\t\t\t\tNextRecordType, and NextRecordIdentifier (if any) from the\n\t\t\tresponse. Then submit another ListResourceRecordSets request, and specify\n\t\t\tthose values for StartRecordName, StartRecordType, and\n\t\t\t\tStartRecordIdentifier.
The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tlist.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "StartRecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "The first name in the lexicographic ordering of resource record sets that you want to\n\t\t\tlist. If the specified record name doesn't exist, the results begin with the first\n\t\t\tresource record set that has a name greater than the value of name.
The type of resource record set to begin the record listing from.
\nValid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | MX | NAPTR |\n\t\t\t\tNS | PTR | SOA | SPF |\n\t\t\t\tSRV | TXT\n
Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT\n
Values for alias resource record sets:
\n\n API Gateway custom regional API or edge-optimized\n\t\t\t\t\t\tAPI: A
\n\n CloudFront distribution: A or AAAA
\n\n Elastic Beanstalk environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A
\n\n Elastic Load Balancing load balancer: A |\n\t\t\t\t\tAAAA
\n\n S3 bucket: A
\n\n VPC interface VPC endpoint: A
\n\n Another resource record set in this hosted\n\t\t\t\t\t\tzone: The type of the resource record set that the alias\n\t\t\t\t\treferences.
\nConstraint: Specifying type without specifying name returns\n\t\t\tan InvalidInput error.
\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, specify\n\t\t\tthe value of NextRecordIdentifier from the previous response to get the\n\t\t\tnext resource record set that has the current DNS name and type.
(Optional) The maximum number of resource records sets to include in the response body\n\t\t\tfor this request. If the response includes more than maxitems resource\n\t\t\trecord sets, the value of the IsTruncated element in the response is\n\t\t\t\ttrue, and the values of the NextRecordName and\n\t\t\t\tNextRecordType elements in the response identify the first resource\n\t\t\trecord set in the next group of maxitems resource record sets.
A request for the resource record sets that are associated with a specified hosted\n\t\t\tzone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListResourceRecordSetsResponse": { - "type": "structure", - "members": { - "ResourceRecordSets": { - "target": "com.amazonaws.route53#ResourceRecordSets", - "traits": { - "smithy.api#documentation": "Information about multiple resource record sets.
", - "smithy.api#required": {} - } - }, - "IsTruncated": { - "target": "com.amazonaws.route53#PageTruncated", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "A flag that indicates whether more resource record sets remain to be listed. If your\n\t\t\tresults were truncated, you can make a follow-up pagination request by using the\n\t\t\t\tNextRecordName element.
If the results were truncated, the name of the next record in the list.
\nThis element is present only if IsTruncated is true.
If the results were truncated, the type of the next record in the list.
\nThis element is present only if IsTruncated is true.
\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, the\n\t\t\tvalue of SetIdentifier for the next resource record set that has the\n\t\t\tcurrent DNS name and type.
For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.
" - } - }, - "MaxItems": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The maximum number of records you requested.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains list information for the resource record set.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListReusableDelegationSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListReusableDelegationSetsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListReusableDelegationSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves a list of the reusable delegation sets that are associated with the current\n\t\t\t\tAmazon Web Services account.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/delegationset", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListReusableDelegationSetsRequest": { - "type": "structure", - "members": { - "Marker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more reusable delegation sets. To get another group,\n\t\t\tsubmit another ListReusableDelegationSets request.
For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first reusable delegation set that\n\t\t\tAmazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more reusable delegation sets to get.
The number of reusable delegation sets that you want Amazon Route 53 to return in the\n\t\t\tresponse to this request. If you specify a value greater than 100, Route 53 returns only\n\t\t\tthe first 100 reusable delegation sets.
", - "smithy.api#httpQuery": "maxitems" - } - } - }, - "traits": { - "smithy.api#documentation": "A request to get a list of the reusable delegation sets that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListReusableDelegationSetsResponse": { - "type": "structure", - "members": { - "DelegationSets": { - "target": "com.amazonaws.route53#DelegationSets", - "traits": { - "smithy.api#documentation": "A complex type that contains one DelegationSet element for each reusable\n\t\t\tdelegation set that was created by the current Amazon Web Services account.
For the second and subsequent calls to ListReusableDelegationSets,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.
A flag that indicates whether there are more reusable delegation sets to be\n\t\t\tlisted.
", - "smithy.api#required": {} - } - }, - "NextMarker": { - "target": "com.amazonaws.route53#PageMarker", - "traits": { - "smithy.api#documentation": "If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the next reusable delegation set that Amazon Route 53 will return if you\n\t\t\tsubmit another ListReusableDelegationSets request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListReusableDelegationSets that produced the current response.
A complex type that contains information about the reusable delegation sets that are\n\t\t\tassociated with the current Amazon Web Services account.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "Lists tags for one health check or hosted zone.
\nFor information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.
", - "smithy.api#http": { - "method": "GET", - "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "The type of the resource.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
The ID of the resource for which you want to retrieve tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type containing information about a request for a list of the tags that are\n\t\t\tassociated with an individual resource.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "ResourceTagSet": { - "target": "com.amazonaws.route53#ResourceTagSet", - "traits": { - "smithy.api#documentation": "A ResourceTagSet containing tags associated with the specified\n\t\t\tresource.
A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTagsForResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTagsForResourcesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTagsForResourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - }, - { - "target": "com.amazonaws.route53#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "Lists tags for up to 10 health checks or hosted zones.
\nFor information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/tags/{ResourceType}", - "code": 200 - } - } - }, - "com.amazonaws.route53#ListTagsForResourcesRequest": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "The type of the resources.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
A complex type that contains the ResourceId element for each resource for which you\n\t\t\twant to get a list of tags.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTagsForResourcesResponse": { - "type": "structure", - "members": { - "ResourceTagSets": { - "target": "com.amazonaws.route53#ResourceTagSetList", - "traits": { - "smithy.api#documentation": "A list of ResourceTagSets containing tags associated with the specified\n\t\t\tresources.
A complex type containing tags for the specified resources.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicies": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPoliciesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPoliciesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the latest version for every traffic policy that is associated\n\t\t\twith the current Amazon Web Services account. Policies are listed in the order that they\n\t\t\twere created in.
\nFor information about how of deleting a traffic policy affects the response from\n\t\t\t\tListTrafficPolicies, see DeleteTrafficPolicy.
(Conditional) For your first request to ListTrafficPolicies, don't\n\t\t\tinclude the TrafficPolicyIdMarker parameter.
If you have more traffic policies than the value of MaxItems,\n\t\t\t\tListTrafficPolicies returns only the first MaxItems\n\t\t\ttraffic policies. To get the next group of policies, submit another request to\n\t\t\t\tListTrafficPolicies. For the value of\n\t\t\t\tTrafficPolicyIdMarker, specify the value of\n\t\t\t\tTrafficPolicyIdMarker that was returned in the previous\n\t\t\tresponse.
(Optional) The maximum number of traffic policies that you want Amazon Route 53 to\n\t\t\treturn in response to this request. If you have more than MaxItems traffic\n\t\t\tpolicies, the value of IsTruncated in the response is true,\n\t\t\tand the value of TrafficPolicyIdMarker is the ID of the first traffic\n\t\t\tpolicy that Route 53 will return if you submit another request.
A complex type that contains the information about the request to list the traffic\n\t\t\tpolicies that are associated with the current Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPoliciesResponse": { - "type": "structure", - "members": { - "TrafficPolicySummaries": { - "target": "com.amazonaws.route53#TrafficPolicySummaries", - "traits": { - "smithy.api#documentation": "A list that contains one TrafficPolicySummary element for each traffic\n\t\t\tpolicy that was created by the current Amazon Web Services account.
A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicies request and specifying the value of\n\t\t\t\tTrafficPolicyIdMarker in the TrafficPolicyIdMarker request\n\t\t\tparameter.
If the value of IsTruncated is true,\n\t\t\t\tTrafficPolicyIdMarker is the ID of the first traffic policy in the next\n\t\t\tgroup of MaxItems traffic policies.
The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicies request that produced the current response.
A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the traffic policy instances that you created by using the\n\t\t\tcurrent Amazon Web Services account.
\nAfter you submit an UpdateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. For more information, see the\n\t\t\t\t\tState response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.
Gets information about the traffic policy instances that you created in a specified\n\t\t\thosted zone.
\nAfter you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.
The ID of the hosted zone that you want to list traffic policy instances for.
", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "TrafficPolicyInstanceNameMarker": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.
A request for the traffic policy instances that you created in a specified hosted\n\t\t\tzone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of traffic policy instances.
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is\n\t\t\tthe DNS type of the resource record sets that are associated with the first traffic\n\t\t\tpolicy instance in the next group of traffic policy instances.
A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tsubmitting another ListTrafficPolicyInstancesByHostedZone request and\n\t\t\tspecifying the values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.
The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicyInstancesByHostedZone request that produced the\n\t\t\tcurrent response.
A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about the traffic policy instances that you created by using a\n\t\t\tspecify traffic policy version.
\nAfter you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.
The ID of the traffic policy for which you want to list traffic policy\n\t\t\tinstances.
", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version of the traffic policy for which you want to list traffic policy instances.\n\t\t\tThe version must be associated with the traffic policy that is specified by\n\t\t\t\tTrafficPolicyId.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.
For the value of hostedzoneid, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance that Amazon Route 53 will return if you submit\n\t\t\tanother request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.
For the value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.
For the value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.
A complex type that contains the information about the request to list your traffic\n\t\t\tpolicy instances.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.
If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance in the next group of\n\t\t\ttraffic policy instances.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance in the next group of\n\t\t\t\tMaxItems traffic policy instances.
A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tcalling ListTrafficPolicyInstancesByPolicy again and specifying the values\n\t\t\tof the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker elements in the corresponding request\n\t\t\tparameters.
The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstancesByPolicy that produced the current\n\t\t\tresponse.
A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesRequest": { - "type": "structure", - "members": { - "HostedZoneIdMarker": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of HostedZoneId, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
The maximum number of traffic policy instances that you want Amazon Route 53 to return\n\t\t\tin response to a ListTrafficPolicyInstances request. If you have more than\n\t\t\t\tMaxItems traffic policy instances, the value of the\n\t\t\t\tIsTruncated element in the response is true, and the\n\t\t\tvalues of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.
A request to get information about the traffic policy instances that you created by\n\t\t\tusing the current Amazon Web Services account.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstances": { - "target": "com.amazonaws.route53#TrafficPolicyInstances", - "traits": { - "smithy.api#documentation": "A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.
If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance that Route 53 will return\n\t\t\tif you submit another ListTrafficPolicyInstances request.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance that Route 53 will return if you submit another\n\t\t\t\tListTrafficPolicyInstances request.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance that Amazon Route 53\n\t\t\twill return if you submit another ListTrafficPolicyInstances request.\n\t\t
A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get more traffic policy instances by calling\n\t\t\t\tListTrafficPolicyInstances again and specifying the values of the\n\t\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.
The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstances that produced the current response.
A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListTrafficPolicyVersionsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListTrafficPolicyVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - } - ], - "traits": { - "smithy.api#documentation": "Gets information about all of the versions for a specified traffic policy.
\nTraffic policy versions are listed in numerical order by\n\t\t\tVersionNumber.
Specify the value of Id of the traffic policy for which you want to list\n\t\t\tall versions.
For your first request to ListTrafficPolicyVersions, don't include the\n\t\t\t\tTrafficPolicyVersionMarker parameter.
If you have more traffic policy versions than the value of MaxItems,\n\t\t\t\tListTrafficPolicyVersions returns only the first group of\n\t\t\t\tMaxItems versions. To get more traffic policy versions, submit another\n\t\t\t\tListTrafficPolicyVersions request. For the value of\n\t\t\t\tTrafficPolicyVersionMarker, specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the previous response.
The maximum number of traffic policy versions that you want Amazon Route 53 to include\n\t\t\tin the response body for this request. If the specified traffic policy has more than\n\t\t\t\tMaxItems versions, the value of IsTruncated in the\n\t\t\tresponse is true, and the value of the\n\t\t\t\tTrafficPolicyVersionMarker element is the ID of the first version that\n\t\t\tRoute 53 will return if you submit another request.
A complex type that contains the information about the request to list your traffic\n\t\t\tpolicies.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListTrafficPolicyVersionsResponse": { - "type": "structure", - "members": { - "TrafficPolicies": { - "target": "com.amazonaws.route53#TrafficPolicies", - "traits": { - "smithy.api#documentation": "A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.
A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicyVersions request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.
If IsTruncated is true, the value of\n\t\t\t\tTrafficPolicyVersionMarker identifies the first traffic policy that\n\t\t\tAmazon Route 53 will return if you submit another request. Call\n\t\t\t\tListTrafficPolicyVersions again and specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the\n\t\t\t\tTrafficPolicyVersionMarker request parameter.
This element is present only if IsTruncated is true.
The value that you specified for the maxitems parameter in the\n\t\t\t\tListTrafficPolicyVersions request that produced the current\n\t\t\tresponse.
A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizations": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest" - }, - "output": { - "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#InvalidPaginationToken" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "Gets a list of the VPCs that were created by other accounts and that can be associated\n\t\t\twith a specified hosted zone because you've submitted one or more\n\t\t\t\tCreateVPCAssociationAuthorization requests.
The response includes a VPCs element with a VPC child\n\t\t\telement for each VPC that can be associated with the hosted zone.
The ID of the hosted zone for which you want a list of VPCs that can be associated\n\t\t\twith the hosted zone.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "\n Optional: If a response includes a NextToken\n\t\t\telement, there are more VPCs that can be associated with the specified hosted zone. To\n\t\t\tget the next page of results, submit another request, and include the value of\n\t\t\t\tNextToken from the response in the nexttoken parameter in\n\t\t\tanother ListVPCAssociationAuthorizations request.
\n Optional: An integer that specifies the maximum number of VPCs\n\t\t\tthat you want Amazon Route 53 to return. If you don't specify a value for\n\t\t\t\tMaxResults, Route 53 returns up to 50 VPCs per page.
A complex type that contains information about that can be associated with your hosted\n\t\t\tzone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { - "type": "structure", - "members": { - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the hosted zone that you can associate the listed VPCs with.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.route53#PaginationToken", - "traits": { - "smithy.api#documentation": "When the response includes a NextToken element, there are more VPCs that\n\t\t\tcan be associated with the specified hosted zone. To get the next page of VPCs, submit\n\t\t\tanother ListVPCAssociationAuthorizations request, and include the value of\n\t\t\tthe NextToken element from the response in the nexttoken\n\t\t\trequest parameter.
The list of VPCs that are authorized to be associated with the specified hosted\n\t\t\tzone.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the request.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#LocationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#LocationSummary" - } - }, - "com.amazonaws.route53#LocationSummary": { - "type": "structure", - "members": { - "LocationName": { - "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", - "traits": { - "smithy.api#documentation": "A string that specifies a location name.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the CIDR location.
" - } - }, - "com.amazonaws.route53#MeasureLatency": { - "type": "boolean" - }, - "com.amazonaws.route53#Message": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#MetricName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#Nameserver": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#Namespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#NoSuchChange": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "A change with the specified change ID does not exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCidrCollectionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The CIDR collection you specified, doesn't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCidrLocationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The CIDR collection location doesn't match any locations in your account.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "There is no CloudWatch Logs log group with the specified ARN.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchDelegationSet": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "A reusable delegation set with the specified ID does not exist.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#NoSuchGeoLocation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "Amazon Route 53 doesn't support the specified geographic location. For a list of\n\t\t\tsupported geolocation codes, see the GeoLocation data\n\t\t\ttype.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchHealthCheck": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "No health check exists with the specified ID.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchHostedZone": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "No hosted zone exists with the ID that you specified.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchKeySigningKey": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The specified key-signing key (KSK) doesn't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchQueryLoggingConfig": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "There is no DNS query logging configuration with the specified ID.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchTrafficPolicy": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "No traffic policy exists with the specified ID.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#NoSuchTrafficPolicyInstance": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "No traffic policy instance exists with the specified ID.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#Nonce": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.route53#NotAuthorizedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "Associating the specified VPC with the specified hosted zone has not been\n\t\t\tauthorized.
", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.route53#PageMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#PageTruncated": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.route53#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#Period": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60 - } - } - }, - "com.amazonaws.route53#Port": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.route53#PriorRequestNotComplete": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "If Amazon Route 53 can't process a request before the next request arrives, it will\n\t\t\treject subsequent requests for the same hosted zone and return an HTTP 400\n\t\t\t\terror (Bad request). If Route 53 returns this error repeatedly\n\t\t\tfor the same request, we recommend that you wait, in intervals of increasing duration,\n\t\t\tbefore you try the request again.
You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't\n\t\t\tsupport associating a VPC with a public hosted zone.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#QueryLoggingConfig": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#QueryLoggingConfigId", - "traits": { - "smithy.api#documentation": "The ID for a configuration for DNS query logging.
", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the hosted zone that CloudWatch Logs is logging queries for.
", - "smithy.api#required": {} - } - }, - "CloudWatchLogsLogGroupArn": { - "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\n\t\t\tis publishing logs to.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about a configuration for DNS query\n\t\t\tlogging.
" - } - }, - "com.amazonaws.route53#QueryLoggingConfigAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "You can create only one query logging configuration for a hosted zone, and a query\n\t\t\tlogging configuration already exists for this hosted zone.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#QueryLoggingConfigId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#QueryLoggingConfigs": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#QueryLoggingConfig", - "traits": { - "smithy.api#xmlName": "QueryLoggingConfig" - } - } - }, - "com.amazonaws.route53#RData": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4000 - } - } - }, - "com.amazonaws.route53#RRType": { - "type": "enum", - "members": { - "SOA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOA" - } - }, - "A": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A" - } - }, - "TXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TXT" - } - }, - "NS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NS" - } - }, - "CNAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CNAME" - } - }, - "MX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MX" - } - }, - "NAPTR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAPTR" - } - }, - "PTR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTR" - } - }, - "SRV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SRV" - } - }, - "SPF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPF" - } - }, - "AAAA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AAAA" - } - }, - "CAA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAA" - } - }, - "DS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DS" - } - } - } - }, - "com.amazonaws.route53#RecordData": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#RecordDataEntry", - "traits": { - "smithy.api#xmlName": "RecordDataEntry" - } - } - }, - "com.amazonaws.route53#RecordDataEntry": { - "type": "string", - "traits": { - "smithy.api#documentation": "A value that Amazon Route 53 returned for this resource record set. A\n\t\t\t\tRecordDataEntry element is one of the following:
For non-alias resource record sets, a RecordDataEntry element\n\t\t\t\t\tcontains one value in the resource record set. If the resource record set\n\t\t\t\t\tcontains multiple values, the response includes one RecordDataEntry\n\t\t\t\t\telement for each value.
For multiple resource record sets that have the same name and type, which\n\t\t\t\t\tincludes weighted, latency, geolocation, and failover, a\n\t\t\t\t\t\tRecordDataEntry element contains the value from the appropriate\n\t\t\t\t\tresource record set based on the request.
For alias resource record sets that refer to Amazon Web Services resources\n\t\t\t\t\tother than another resource record set, the RecordDataEntry element\n\t\t\t\t\tcontains an IP address or a domain name for the Amazon Web Services resource,\n\t\t\t\t\tdepending on the type of resource.
For alias resource record sets that refer to other resource record sets, a\n\t\t\t\t\t\tRecordDataEntry element contains one value from the referenced\n\t\t\t\t\tresource record set. If the referenced resource record set contains multiple\n\t\t\t\t\tvalues, the response includes one RecordDataEntry element for each\n\t\t\t\t\tvalue.
The current or new DNS record value, not to exceed 4,000 characters. In the case of a\n\t\t\t\tDELETE action, if the current value does not match the actual value, an\n\t\t\terror is returned. For descriptions about how to format Value for different\n\t\t\trecord types, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.
You can specify more than one value for all record types except CNAME and\n\t\t\t\tSOA.
If you're creating an alias resource record set, omit Value.
Information specific to the resource record.
\nIf you're creating an alias resource record set, omit\n\t\t\t\tResourceRecord.
For ChangeResourceRecordSets requests, the name of the record that you\n\t\t\twant to create, update, or delete. For ListResourceRecordSets responses,\n\t\t\tthe name of a record in the specified hosted zone.
\n ChangeResourceRecordSets Only\n
\nEnter a fully qualified domain name, for example, www.example.com. You\n\t\t\tcan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\n\t\t\tassumes that the domain name that you specify is fully qualified. This means that Route\n\t\t\t53 treats www.example.com (without a trailing dot) and\n\t\t\t\twww.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see DNS Domain Name\n\t\t\t\tFormat in the Amazon Route 53 Developer Guide.
You can use the asterisk (*) wildcard to replace the leftmost label in a domain name,\n\t\t\tfor example, *.example.com. Note the following:
The * must replace the entire label. For example, you can't specify\n\t\t\t\t\t\t*prod.example.com or prod*.example.com.
The * can't replace any of the middle labels, for example,\n\t\t\t\t\tmarketing.*.example.com.
\nIf you include * in any position other than the leftmost label in a domain\n\t\t\t\t\tname, DNS treats it as an * character (ASCII 42), not as a wildcard.
\nYou can't use the * wildcard for resource records sets that have a type of\n\t\t\t\t\t\tNS.
\nYou can use the * wildcard as the leftmost label in a domain name, for example,\n\t\t\t\t*.example.com. You can't use an * for one of the middle labels, for\n\t\t\texample, marketing.*.example.com. In addition, the * must replace the\n\t\t\tentire label; for example, you can't specify prod*.example.com.
The DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.
\nValid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n
Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.
Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n
SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.
Values for alias resource record sets:
\n\n Amazon API Gateway custom regional APIs and\n\t\t\t\t\t\tedge-optimized APIs:\n A\n
\n CloudFront distributions:\n A\n
If IPv6 is enabled for the distribution, create two resource record sets to\n\t\t\t\t\troute traffic to your distribution, one with a value of A and one\n\t\t\t\t\twith a value of AAAA.
\n Amazon API Gateway environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A\n
\n ELB load balancers:\n A | AAAA\n
\n Amazon S3 buckets:\n A\n
\n Amazon Virtual Private Cloud interface VPC\n\t\t\t\t\t\tendpoints\n A\n
\n Another resource record set in this hosted\n\t\t\t\t\t\tzone: Specify the type of the resource record set that you're\n\t\t\t\t\tcreating the alias for. All values are supported except NS and\n\t\t\t\t\t\tSOA.
If you're creating an alias record that has the same name as the hosted\n\t\t\t\t\t\tzone (known as the zone apex), you can't route traffic to a record for which\n\t\t\t\t\t\tthe value of Type is CNAME. This is because the\n\t\t\t\t\t\talias record must have the same type as the record you're routing traffic\n\t\t\t\t\t\tto, and creating a CNAME record for the zone apex isn't supported even for\n\t\t\t\t\t\tan alias record.
\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: An identifier that differentiates among multiple resource record\n\t\t\tsets that have the same combination of name and type, such as multiple weighted resource\n\t\t\trecord sets named acme.example.com that have a type of A. In a group of resource record\n\t\t\tsets that have the same name and type, the value of SetIdentifier must be\n\t\t\tunique for each resource record set.
For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.
" - } - }, - "Weight": { - "target": "com.amazonaws.route53#ResourceRecordSetWeight", - "traits": { - "smithy.api#documentation": "\n Weighted resource record sets only: Among resource record sets\n\t\t\tthat have the same combination of DNS name and type, a value that determines the\n\t\t\tproportion of DNS queries that Amazon Route 53 responds to using the current resource\n\t\t\trecord set. Route 53 calculates the sum of the weights for the resource record sets that\n\t\t\thave the same combination of DNS name and type. Route 53 then responds to queries based\n\t\t\ton the ratio of a resource's weight to the total. Note the following:
\nYou must specify a value for the Weight element for every\n\t\t\t\t\tweighted resource record set.
You can only specify one ResourceRecord per weighted resource\n\t\t\t\t\trecord set.
You can't create latency, failover, or geolocation resource record sets that\n\t\t\t\t\thave the same values for the Name and Type elements as\n\t\t\t\t\tweighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the\n\t\t\t\t\tsame values for the Name and Type elements.
For weighted (but not weighted alias) resource record sets, if you set\n\t\t\t\t\t\tWeight to 0 for a resource record set, Route 53\n\t\t\t\t\tnever responds to queries with the applicable value for that resource record\n\t\t\t\t\tset. However, if you set Weight to 0 for all resource\n\t\t\t\t\trecord sets that have the same combination of DNS name and type, traffic is\n\t\t\t\t\trouted to all resources with equal probability.
The effect of setting Weight to 0 is different when\n\t\t\t\t\tyou associate health checks with weighted resource record sets. For more\n\t\t\t\t\tinformation, see Options for Configuring Route 53 Active-Active and Active-Passive\n\t\t\t\t\t\tFailover in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.
\n Latency-based resource record sets only: The Amazon EC2 Region\n\t\t\twhere you created the resource that this resource record set refers to. The resource\n\t\t\ttypically is an Amazon Web Services resource, such as an EC2 instance or an ELB load\n\t\t\tbalancer, and is referred to by an IP address or a DNS domain name, depending on the\n\t\t\trecord type.
\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you\n\t\t\thave created latency resource record sets, Route 53 selects the latency resource record\n\t\t\tset that has the lowest latency between the end user and the associated Amazon EC2\n\t\t\tRegion. Route 53 then returns the value that is associated with the selected resource\n\t\t\trecord set.
\nNote the following:
\nYou can only specify one ResourceRecord per latency resource\n\t\t\t\t\trecord set.
You can only create one latency resource record set for each Amazon EC2\n\t\t\t\t\tRegion.
\nYou aren't required to create latency resource record sets for all Amazon EC2\n\t\t\t\t\tRegions. Route 53 will choose the region with the best latency from among the\n\t\t\t\t\tregions that you create latency resource record sets for.
\nYou can't create non-latency resource record sets that have the same values\n\t\t\t\t\tfor the Name and Type elements as latency resource\n\t\t\t\t\trecord sets.
\n Geolocation resource record sets only: A complex type that lets\n\t\t\tyou control how Amazon Route 53 responds to DNS queries based on the geographic origin\n\t\t\tof the query. For example, if you want all queries from Africa to be routed to a web\n\t\t\tserver with an IP address of 192.0.2.111, create a resource record set with\n\t\t\ta Type of A and a ContinentCode of\n\t\t\t\tAF.
Although creating geolocation and geolocation alias resource record sets in a\n\t\t\t\tprivate hosted zone is allowed, it's not supported.
\nIf you create separate resource record sets for overlapping geographic regions (for\n\t\t\texample, one resource record set for a continent and one for a country on the same\n\t\t\tcontinent), priority goes to the smallest geographic region. This allows you to route\n\t\t\tmost queries for a continent to one resource and to route queries for a country on that\n\t\t\tcontinent to a different resource.
\nYou can't create two geolocation resource record sets that specify the same geographic\n\t\t\tlocation.
\nThe value * in the CountryCode element matches all\n\t\t\tgeographic locations that aren't specified in other geolocation resource record sets\n\t\t\tthat have the same values for the Name and Type\n\t\t\telements.
Geolocation works by mapping IP addresses to locations. However, some IP addresses\n\t\t\t\taren't mapped to geographic locations, so even if you create geolocation resource\n\t\t\t\trecord sets that cover all seven continents, Route 53 will receive some DNS queries\n\t\t\t\tfrom locations that it can't identify. We recommend that you create a resource\n\t\t\t\trecord set for which the value of CountryCode is *. Two\n\t\t\t\tgroups of queries are routed to the resource that you specify in this record:\n\t\t\t\tqueries that come from locations for which you haven't created geolocation resource\n\t\t\t\trecord sets and queries from IP addresses that aren't mapped to a location. If you\n\t\t\t\tdon't create a * resource record set, Route 53 returns a \"no answer\"\n\t\t\t\tresponse for queries from those locations.
You can't create non-geolocation resource record sets that have the same values for\n\t\t\tthe Name and Type elements as geolocation resource record\n\t\t\tsets.
\n Failover resource record sets only: To configure failover, you\n\t\t\tadd the Failover element to two resource record sets. For one resource\n\t\t\trecord set, you specify PRIMARY as the value for Failover; for\n\t\t\tthe other resource record set, you specify SECONDARY. In addition, you\n\t\t\tinclude the HealthCheckId element and specify the health check that you\n\t\t\twant Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the\n\t\t\t\tHealthCheckId element in both resource record sets:
When the primary resource record set is healthy, Route 53 responds to DNS\n\t\t\t\t\tqueries with the applicable value from the primary resource record set\n\t\t\t\t\tregardless of the health of the secondary resource record set.
\nWhen the primary resource record set is unhealthy and the secondary resource\n\t\t\t\t\trecord set is healthy, Route 53 responds to DNS queries with the applicable\n\t\t\t\t\tvalue from the secondary resource record set.
\nWhen the secondary resource record set is unhealthy, Route 53 responds to DNS\n\t\t\t\t\tqueries with the applicable value from the primary resource record set\n\t\t\t\t\tregardless of the health of the primary resource record set.
\nIf you omit the HealthCheckId element for the secondary resource\n\t\t\t\t\trecord set, and if the primary resource record set is unhealthy, Route 53 always\n\t\t\t\t\tresponds to DNS queries with the applicable value from the secondary resource\n\t\t\t\t\trecord set. This is true regardless of the health of the associated\n\t\t\t\t\tendpoint.
You can't create non-failover resource record sets that have the same values for the\n\t\t\t\tName and Type elements as failover resource record\n\t\t\tsets.
For failover alias resource record sets, you must also include the\n\t\t\t\tEvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Route 53, see the following topics\n\t\t\tin the Amazon Route 53 Developer Guide:
\n\n Multivalue answer resource record sets only: To route traffic\n\t\t\tapproximately randomly to multiple resources, such as web servers, create one multivalue\n\t\t\tanswer record for each resource and specify true for\n\t\t\t\tMultiValueAnswer. Note the following:
If you associate a health check with a multivalue answer resource record set,\n\t\t\t\t\tAmazon Route 53 responds to DNS queries with the corresponding IP address only\n\t\t\t\t\twhen the health check is healthy.
\nIf you don't associate a health check with a multivalue answer record, Route\n\t\t\t\t\t53 always considers the record to be healthy.
\nRoute 53 responds to DNS queries with up to eight healthy records; if you have\n\t\t\t\t\teight or fewer healthy records, Route 53 responds to all DNS queries with all\n\t\t\t\t\tthe healthy records.
\nIf you have more than eight healthy records, Route 53 responds to different\n\t\t\t\t\tDNS resolvers with different combinations of healthy records.
\nWhen all records are unhealthy, Route 53 responds to DNS queries with up to\n\t\t\t\t\teight unhealthy records.
\nIf a resource becomes unavailable after a resolver caches a response, client\n\t\t\t\t\tsoftware typically tries another of the IP addresses in the response.
\nYou can't create multivalue answer alias records.
" - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "The resource record cache time to live (TTL), in seconds. Note the following:
\nIf you're creating or updating an alias resource record set, omit\n\t\t\t\t\t\tTTL. Amazon Route 53 uses the value of TTL for the\n\t\t\t\t\talias target.
If you're associating this resource record set with a health check (if you're\n\t\t\t\t\tadding a HealthCheckId element), we recommend that you specify a\n\t\t\t\t\t\tTTL of 60 seconds or less so clients respond quickly to changes\n\t\t\t\t\tin health status.
All of the resource record sets in a group of weighted resource record sets\n\t\t\t\t\tmust have the same value for TTL.
If a group of weighted resource record sets includes one or more weighted\n\t\t\t\t\talias resource record sets for which the alias target is an ELB load balancer,\n\t\t\t\t\twe recommend that you specify a TTL of 60 seconds for all of the\n\t\t\t\t\tnon-alias weighted resource record sets that have the same name and type. Values\n\t\t\t\t\tother than 60 seconds (the TTL for load balancers) will change the effect of the\n\t\t\t\t\tvalues that you specify for Weight.
Information about the resource records to act upon.
\nIf you're creating an alias resource record set, omit\n\t\t\t\tResourceRecords.
\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.
\nIf you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:
\nYou can't create an alias resource record set in a private hosted zone to\n\t\t\t\t\troute traffic to a CloudFront distribution.
\nFor information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see Configuring Failover in a Private Hosted Zone in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you want Amazon Route 53 to return this resource record set in response to a DNS\n\t\t\tquery only when the status of a health check is healthy, include the\n\t\t\t\tHealthCheckId element and specify the ID of the applicable health\n\t\t\tcheck.
Route 53 determines whether a resource record set is healthy based on one of the\n\t\t\tfollowing:
\nBy periodically sending a request to the endpoint that is specified in the\n\t\t\t\t\thealth check
\nBy aggregating the status of a specified group of health checks (calculated\n\t\t\t\t\thealth checks)
\nBy determining the current state of a CloudWatch alarm (CloudWatch metric\n\t\t\t\t\thealth checks)
\nRoute 53 doesn't check the health of the endpoint that is specified in the\n\t\t\t\tresource record set, for example, the endpoint specified by the IP address in the\n\t\t\t\t\tValue element. When you add a HealthCheckId element to\n\t\t\t\ta resource record set, Route 53 checks the health of the endpoint that you specified\n\t\t\t\tin the health check.
For more information, see the following topics in the Amazon Route 53\n\t\t\t\tDeveloper Guide:
\n\n How Amazon Route 53 Determines Whether an Endpoint Is\n\t\t\t\t\tHealthy\n
\n\n When to Specify HealthCheckId\n
\nSpecifying a value for HealthCheckId is useful only when Route 53 is\n\t\t\tchoosing between two or more resource record sets to respond to a DNS query, and you\n\t\t\twant Route 53 to base the choice in part on the status of a health check. Configuring\n\t\t\thealth checks makes sense only in the following configurations:
\n Non-alias resource record sets: You're\n\t\t\t\t\tchecking the health of a group of non-alias resource record sets that have the\n\t\t\t\t\tsame routing policy, name, and type (such as multiple weighted records named\n\t\t\t\t\twww.example.com with a type of A) and you specify health check IDs for all the\n\t\t\t\t\tresource record sets.
\nIf the health check status for a resource record set is healthy, Route 53\n\t\t\t\t\tincludes the record among the records that it responds to DNS queries\n\t\t\t\t\twith.
\nIf the health check status for a resource record set is unhealthy, Route 53\n\t\t\t\t\tstops responding to DNS queries using the value for that resource record\n\t\t\t\t\tset.
\nIf the health check status for all resource record sets in the group is\n\t\t\t\t\tunhealthy, Route 53 considers all resource record sets in the group healthy and\n\t\t\t\t\tresponds to DNS queries accordingly.
\n\n Alias resource record sets: You specify the\n\t\t\t\t\tfollowing settings:
\nYou set EvaluateTargetHealth to true for an alias\n\t\t\t\t\t\t\tresource record set in a group of resource record sets that have the\n\t\t\t\t\t\t\tsame routing policy, name, and type (such as multiple weighted records\n\t\t\t\t\t\t\tnamed www.example.com with a type of A).
You configure the alias resource record set to route traffic to a\n\t\t\t\t\t\t\tnon-alias resource record set in the same hosted zone.
\nYou specify a health check ID for the non-alias resource record set.\n\t\t\t\t\t\t
\nIf the health check status is healthy, Route 53 considers the alias resource\n\t\t\t\t\trecord set to be healthy and includes the alias record among the records that it\n\t\t\t\t\tresponds to DNS queries with.
\nIf the health check status is unhealthy, Route 53 stops responding to DNS\n\t\t\t\t\tqueries using the alias resource record set.
\nThe alias resource record set can also route traffic to a\n\t\t\t\t\t\t\tgroup of non-alias resource record sets that have\n\t\t\t\t\t\tthe same routing policy, name, and type. In that configuration, associate\n\t\t\t\t\t\thealth checks with all of the resource record sets in the group of non-alias\n\t\t\t\t\t\tresource record sets.
\n\n Geolocation Routing\n
\nFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\n\t\t\ta resource record set for the larger, associated geographic region. For example, suppose\n\t\t\tyou have resource record sets for a state in the United States, for the entire United\n\t\t\tStates, for North America, and a resource record set that has * for\n\t\t\t\tCountryCode is *, which applies to all locations. If the\n\t\t\tendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\n\t\t\tresource record sets in the following order until it finds a resource record set for\n\t\t\twhich the endpoint is healthy:
The United States
\nNorth America
\nThe default resource record set
\n\n Specifying the Health Check Endpoint by Domain\n\t\t\tName\n
\nIf your health checks specify the endpoint only by domain name, we recommend that you\n\t\t\tcreate a separate health check for each endpoint. For example, create a health check for\n\t\t\teach HTTP server that is serving content for www.example.com.\n\t\t\tFor the value of FullyQualifiedDomainName, specify the domain name of the\n\t\t\tserver (such as us-east-2-www.example.com), not the name of the resource\n\t\t\trecord sets (www.example.com).
Health check results will be unpredictable if you do the following:
\nCreate a health check that has the same value for\n\t\t\t\t\t\t\tFullyQualifiedDomainName as the name of a resource record\n\t\t\t\t\t\tset.
Associate that health check with the resource record set.
\nWhen you create a traffic policy instance, Amazon Route 53 automatically creates a\n\t\t\tresource record set. TrafficPolicyInstanceId is the ID of the traffic\n\t\t\tpolicy instance that Route 53 created this resource record set for.
To delete the resource record set that is associated with a traffic policy\n\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Route 53 will delete the\n\t\t\t\tresource record set automatically. If you delete the resource record set by using\n\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the\n\t\t\t\ttraffic policy instance, and you'll continue to be charged for it even though it's\n\t\t\t\tno longer in use.
Information about the resource record set to create or delete.
" - } - }, - "com.amazonaws.route53#ResourceRecordSetFailover": { - "type": "enum", - "members": { - "PRIMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY" - } - }, - "SECONDARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDARY" - } - } - } - }, - "com.amazonaws.route53#ResourceRecordSetIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer": { - "type": "boolean" - }, - "com.amazonaws.route53#ResourceRecordSetRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "cn_northwest_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-northwest-1" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - }, - "ap_southeast_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-4" - } - }, - "il_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "il-central-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#ResourceRecordSetWeight": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ResourceRecordSets": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceRecordSet", - "traits": { - "smithy.api#xmlName": "ResourceRecordSet" - } - } - }, - "com.amazonaws.route53#ResourceRecords": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceRecord", - "traits": { - "smithy.api#xmlName": "ResourceRecord" - } - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.route53#ResourceTagSet": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.route53#TagResourceType", - "traits": { - "smithy.api#documentation": "The type of the resource.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
The ID for the specified resource.
" - } - }, - "Tags": { - "target": "com.amazonaws.route53#TagList", - "traits": { - "smithy.api#documentation": "The tags associated with the specified resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type containing a resource and its associated tags.
" - } - }, - "com.amazonaws.route53#ResourceTagSetList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#ResourceTagSet", - "traits": { - "smithy.api#xmlName": "ResourceTagSet" - } - } - }, - "com.amazonaws.route53#ResourceURI": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#ReusableDelegationSetLimit": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", - "traits": { - "smithy.api#documentation": "The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the\n\t\t\tmaximum number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.
The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET\n\t\t\tlimit.
A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.
" - } - }, - "com.amazonaws.route53#ReusableDelegationSetLimitType": { - "type": "enum", - "members": { - "MAX_ZONES_BY_REUSABLE_DELEGATION_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" - } - } - } - }, - "com.amazonaws.route53#RoutingControlArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.route53#SearchString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "com.amazonaws.route53#ServeSignature": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.route53#ServicePrincipal": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#SigningKeyInteger": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.route53#SigningKeyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 128 - } - } - }, - "com.amazonaws.route53#SigningKeyStatus": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 150 - } - } - }, - "com.amazonaws.route53#SigningKeyStatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#SigningKeyString": { - "type": "string" - }, - "com.amazonaws.route53#SigningKeyTag": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65536 - } - } - }, - "com.amazonaws.route53#Statistic": { - "type": "enum", - "members": { - "Average": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Average" - } - }, - "Sum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Sum" - } - }, - "SampleCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SampleCount" - } - }, - "Maximum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Maximum" - } - }, - "Minimum": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Minimum" - } - } - } - }, - "com.amazonaws.route53#Status": { - "type": "string" - }, - "com.amazonaws.route53#StatusReport": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.route53#Status", - "traits": { - "smithy.api#documentation": "A description of the status of the health check endpoint as reported by one of the\n\t\t\tAmazon Route 53 health checkers.
" - } - }, - "CheckedTime": { - "target": "com.amazonaws.route53#TimeStamp", - "traits": { - "smithy.api#documentation": "The date and time that the health checker performed the health check in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.
A complex type that contains the status that one Amazon Route 53 health checker\n\t\t\treports and the time of the health check.
" - } - }, - "com.amazonaws.route53#SubnetMask": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.route53#TTL": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 2147483647 - } - } - }, - "com.amazonaws.route53#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.route53#TagKey", - "traits": { - "smithy.api#documentation": "The value of Key depends on the operation that you want to\n\t\t\tperform:
\n Add a tag to a health check or hosted zone:\n\t\t\t\t\t\tKey is the name that you want to give the new tag.
\n Edit a tag: Key is the name of\n\t\t\t\t\tthe tag that you want to change the Value for.
\n Delete a key: Key is the name\n\t\t\t\t\tof the tag you want to remove.
\n Give a name to a health check: Edit the\n\t\t\t\t\tdefault Name tag. In the Amazon Route 53 console, the list of your\n\t\t\t\t\thealth checks includes a Name column that lets\n\t\t\t\t\tyou see the name that you've given to each health check.
The value of Value depends on the operation that you want to\n\t\t\tperform:
\n Add a tag to a health check or hosted zone:\n\t\t\t\t\t\tValue is the value that you want to give the new tag.
\n Edit a tag: Value is the new\n\t\t\t\t\tvalue that you want to assign the tag.
A complex type that contains information about a tag that you want to add or edit for\n\t\t\tthe specified health check or hosted zone.
" - } - }, - "com.amazonaws.route53#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.route53#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TagKey", - "traits": { - "smithy.api#xmlName": "Key" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#Tag", - "traits": { - "smithy.api#xmlName": "Tag" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - } - } - }, - "com.amazonaws.route53#TagResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TagResourceId", - "traits": { - "smithy.api#xmlName": "ResourceId" - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.route53#TagResourceType": { - "type": "enum", - "members": { - "healthcheck": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "healthcheck" - } - }, - "hostedzone": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hostedzone" - } - } - } - }, - "com.amazonaws.route53#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.route53#TestDNSAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#TestDNSAnswerRequest" - }, - "output": { - "target": "com.amazonaws.route53#TestDNSAnswerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHostedZone" - } - ], - "traits": { - "smithy.api#documentation": "Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.
\nThis call only supports querying public hosted zones.
\nThe TestDnsAnswer returns information similar to what you would expect from the answer\n\t\t\tsection of the dig command. Therefore, if you query for the name\n\t\t\tservers of a subdomain that point to the parent name servers, those will not be\n\t\t\treturned.
The ID of the hosted zone that you want Amazon Route 53 to simulate a query\n\t\t\tfor.
", - "smithy.api#httpQuery": "hostedzoneid", - "smithy.api#required": {} - } - }, - "RecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "The name of the resource record set that you want Amazon Route 53 to simulate a query\n\t\t\tfor.
", - "smithy.api#httpQuery": "recordname", - "smithy.api#required": {} - } - }, - "RecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "The type of the resource record set.
", - "smithy.api#httpQuery": "recordtype", - "smithy.api#required": {} - } - }, - "ResolverIP": { - "target": "com.amazonaws.route53#IPAddress", - "traits": { - "smithy.api#documentation": "If you want to simulate a request from a specific DNS resolver, specify the IP address\n\t\t\tfor that resolver. If you omit this value, TestDnsAnswer uses the IP\n\t\t\taddress of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region\n\t\t\t\t(us-east-1).
If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or\n\t\t\tIPv6 address of a client in the applicable location, for example,\n\t\t\t\t192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.
If you specify an IP address for edns0clientsubnetip, you can optionally\n\t\t\tspecify the number of bits of the IP address that you want the checking tool to include\n\t\t\tin the DNS query. For example, if you specify 192.0.2.44 for\n\t\t\t\tedns0clientsubnetip and 24 for\n\t\t\t\tedns0clientsubnetmask, the checking tool will simulate a request from\n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6\n\t\t\taddresses.
The range of valid values depends on whether edns0clientsubnetip is an\n\t\t\tIPv4 or an IPv6 address:
\n IPv4: Specify a value between 0 and 32
\n\n IPv6: Specify a value between 0 and\n\t\t\t\t\t128
\nGets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#TestDNSAnswerResponse": { - "type": "structure", - "members": { - "Nameserver": { - "target": "com.amazonaws.route53#Nameserver", - "traits": { - "smithy.api#documentation": "The Amazon Route 53 name server used to respond to the request.
", - "smithy.api#required": {} - } - }, - "RecordName": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "The name of the resource record set that you submitted a request for.
", - "smithy.api#required": {} - } - }, - "RecordType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "The type of the resource record set that you submitted a request for.
", - "smithy.api#required": {} - } - }, - "RecordData": { - "target": "com.amazonaws.route53#RecordData", - "traits": { - "smithy.api#documentation": "A list that contains values that Amazon Route 53 returned for this resource record\n\t\t\tset.
", - "smithy.api#required": {} - } - }, - "ResponseCode": { - "target": "com.amazonaws.route53#DNSRCode", - "traits": { - "smithy.api#documentation": "A code that indicates whether the request is valid or not. The most common response\n\t\t\tcode is NOERROR, meaning that the request is valid. If the response is not\n\t\t\tvalid, Amazon Route 53 returns a response code that describes the error. For a list of\n\t\t\tpossible response codes, see DNS RCODES on the IANA website.
The protocol that Amazon Route 53 used to respond to the request, either\n\t\t\t\tUDP or TCP.
A complex type that contains the response to a TestDNSAnswer request.\n\t\t
The limit on the number of requests per second was exceeded.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TimeStamp": { - "type": "timestamp" - }, - "com.amazonaws.route53#TooManyHealthChecks": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "This health check can't be created because the current account has reached the limit\n\t\t\ton the number of active health checks.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nFor information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.
\nYou have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#TooManyHostedZones": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "This operation can't be completed either because the current account has reached the\n\t\t\tlimit on the number of hosted zones or because you've reached the limit on the number of\n\t\t\thosted zones that can be associated with a reusable delegation set.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nTo get the current limit on hosted zones that can be created by an account, see GetAccountLimit.
\nTo get the current limit on hosted zones that can be associated with a reusable\n\t\t\tdelegation set, see GetReusableDelegationSetLimit.
\nTo request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyKeySigningKeys": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "You've reached the limit for the number of key-signing keys (KSKs). Remove at least\n\t\t\tone KSK, and then try again.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.route53#TooManyTrafficPolicies": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "This traffic policy can't be created because the current account has reached the limit\n\t\t\ton the number of traffic policies.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nTo get the current limit for an account, see GetAccountLimit.
\nTo request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyTrafficPolicyInstances": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "This traffic policy instance can't be created because the current account has reached\n\t\t\tthe limit on the number of traffic policy instances.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nFor information about how to get the current limit for an account, see GetAccountLimit.
\nTo request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "This traffic policy version can't be created because you've reached the limit of 1000\n\t\t\ton the number of versions that you can create for the current traffic policy.
\nTo create more traffic policy versions, you can use GetTrafficPolicy\n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use\n\t\t\t\tCreateTrafficPolicy to create a new traffic policy using the traffic policy\n\t\t\tdocument.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TooManyVPCAssociationAuthorizations": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "You've created the maximum number of authorizations that can be created for the\n\t\t\tspecified hosted zone. To authorize another VPC to be associated with the hosted zone,\n\t\t\tsubmit a DeleteVPCAssociationAuthorization request to remove an existing\n\t\t\tauthorization. To get a list of existing authorizations, submit a\n\t\t\t\tListVPCAssociationAuthorizations request.
The ID that Amazon Route 53 assigned to a traffic policy when you created it.
", - "smithy.api#required": {} - } - }, - "Version": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic\n\t\t\tpolicy, the value of Version is always 1.
The name that you specified when you created the traffic policy.
", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.
", - "smithy.api#required": {} - } - }, - "Document": { - "target": "com.amazonaws.route53#TrafficPolicyDocument", - "traits": { - "smithy.api#documentation": "The definition of a traffic policy in JSON format. You specify the JSON document to\n\t\t\tuse for a new traffic policy in the CreateTrafficPolicy request. For more\n\t\t\tinformation about the JSON format, see Traffic Policy Document Format.
The comment that you specify in the CreateTrafficPolicy request, if\n\t\t\tany.
A complex type that contains settings for a traffic policy.
" - } - }, - "com.amazonaws.route53#TrafficPolicyAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "A traffic policy that has the same value for Name already exists.
One or more traffic policy instances were created by using the specified traffic\n\t\t\tpolicy.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.route53#TrafficPolicyInstance": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceId", - "traits": { - "smithy.api#documentation": "The ID that Amazon Route 53 assigned to the new traffic policy instance.
", - "smithy.api#required": {} - } - }, - "HostedZoneId": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the hosted zone that Amazon Route 53 created resource record sets in.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#DNSName", - "traits": { - "smithy.api#documentation": "The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries\n\t\t\tby using the resource record sets that are associated with this traffic policy instance.\n\t\t
", - "smithy.api#required": {} - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "The TTL that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated in the specified hosted zone.
", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.route53#TrafficPolicyInstanceState", - "traits": { - "smithy.api#documentation": "The value of State is one of the following values:
Amazon Route 53 has finished creating resource record sets, and changes\n\t\t\t\t\t\thave propagated to all Route 53 edge locations.
\nRoute 53 is creating the resource record sets. Use\n\t\t\t\t\t\t\tGetTrafficPolicyInstance to confirm that the\n\t\t\t\t\t\t\tCreateTrafficPolicyInstance request completed\n\t\t\t\t\t\tsuccessfully.
Route 53 wasn't able to create or update the resource record sets. When\n\t\t\t\t\t\tthe value of State is Failed, see\n\t\t\t\t\t\t\tMessage for an explanation of what caused the request to\n\t\t\t\t\t\tfail.
If State is Failed, an explanation of the reason for the\n\t\t\tfailure. If State is another value, Message is empty.
The ID of the traffic policy that Amazon Route 53 used to create resource record sets\n\t\t\tin the specified hosted zone.
", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version of the traffic policy that Amazon Route 53 used to create resource record\n\t\t\tsets in the specified hosted zone.
", - "smithy.api#required": {} - } - }, - "TrafficPolicyType": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "The DNS type that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated for this traffic policy instance.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the new traffic policy instance.
" - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "There is already a traffic policy instance with the specified ID.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceCount": { - "type": "integer" - }, - "com.amazonaws.route53#TrafficPolicyInstanceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.route53#TrafficPolicyInstanceState": { - "type": "string" - }, - "com.amazonaws.route53#TrafficPolicyInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#xmlName": "TrafficPolicyInstance" - } - } - }, - "com.amazonaws.route53#TrafficPolicyName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.route53#TrafficPolicySummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#TrafficPolicySummary", - "traits": { - "smithy.api#xmlName": "TrafficPolicySummary" - } - } - }, - "com.amazonaws.route53#TrafficPolicySummary": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "The ID that Amazon Route 53 assigned to the traffic policy when you created it.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.route53#TrafficPolicyName", - "traits": { - "smithy.api#documentation": "The name that you specified for the traffic policy when you created it.
", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.route53#RRType", - "traits": { - "smithy.api#documentation": "The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.
", - "smithy.api#required": {} - } - }, - "LatestVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version number of the latest version of the traffic policy.
", - "smithy.api#required": {} - } - }, - "TrafficPolicyCount": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The number of traffic policies that are associated with the current Amazon Web Services account.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the latest version of one traffic\n\t\t\tpolicy that is associated with the current Amazon Web Services account.
" - } - }, - "com.amazonaws.route53#TrafficPolicyVersion": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.route53#TrafficPolicyVersionMarker": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4 - } - } - }, - "com.amazonaws.route53#TransportProtocol": { - "type": "string" - }, - "com.amazonaws.route53#UUID": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" - } - }, - "com.amazonaws.route53#UpdateHealthCheck": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateHealthCheckRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateHealthCheckResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#HealthCheckVersionMismatch" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchHealthCheck" - } - ], - "traits": { - "smithy.api#documentation": "Updates an existing health check. Note that some values can't be updated.
\nFor more information about updating health checks, see Creating,\n\t\t\t\tUpdating, and Deleting Health Checks in the Amazon Route 53\n\t\t\t\tDeveloper Guide.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/healthcheck/{HealthCheckId}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateHealthCheckRequest": { - "type": "structure", - "members": { - "HealthCheckId": { - "target": "com.amazonaws.route53#HealthCheckId", - "traits": { - "smithy.api#documentation": "The ID for the health check for which you want detailed information. When you created\n\t\t\tthe health check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.
A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\thealth check and increments by 1 each time you update settings for the health\n\t\t\tcheck.
We recommend that you use GetHealthCheck or ListHealthChecks\n\t\t\tto get the current value of HealthCheckVersion for the health check that\n\t\t\tyou want to update, and that you include that value in your\n\t\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an\n\t\t\tintervening update:
If the value in the UpdateHealthCheck request matches the value\n\t\t\t\t\tof HealthCheckVersion in the health check, Route 53 updates the\n\t\t\t\t\thealth check with the new settings.
If the value of HealthCheckVersion in the health check is\n\t\t\t\t\tgreater, the health check was changed after you got the version number. Route 53\n\t\t\t\t\tdoes not update the health check, and it returns a\n\t\t\t\t\t\tHealthCheckVersionMismatch error.
The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address that is returned by DNS, Route 53\n\t\t\tthen checks the health of the endpoint.
Use one of the following formats for the value of IPAddress:
\n IPv4 address: four values between 0 and 255,\n\t\t\t\t\tseparated by periods (.), for example, 192.0.2.44.
\n IPv6 address: eight groups of four\n\t\t\t\t\thexadecimal values, separated by colons (:), for example,\n\t\t\t\t\t\t2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten\n\t\t\t\t\tIPv6 addresses as described in RFC 5952, for example,\n\t\t\t\t\t\t2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance never\n\t\t\tchanges. For more information, see the applicable documentation:
Linux: Elastic IP\n\t\t\t\t\t\tAddresses (EIP) in the Amazon EC2 User Guide for Linux\n\t\t\t\t\t\tInstances\n
\nWindows: Elastic IP\n\t\t\t\t\t\tAddresses (EIP) in the Amazon EC2 User Guide for Windows\n\t\t\t\t\t\tInstances\n
\nIf a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.
For more information, see FullyQualifiedDomainName.
\nConstraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:
\n\n RFC 6598, IANA-Reserved IPv4\n\t\t\t\t\t\tPrefix for Shared Address Space\n
\nThe port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.
\nDon't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.
The path that you want Amazon Route 53 to request when performing health checks. The\n\t\t\tpath can be any value for which your endpoint will return an HTTP status code of 2xx or\n\t\t\t3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.\n\t\t\tYou can also include query string parameters, for example,\n\t\t\t\t/welcome.html?language=jp&login=y.
Specify this value only if you want to change it.
" - } - }, - "FullyQualifiedDomainName": { - "target": "com.amazonaws.route53#FullyQualifiedDomainName", - "traits": { - "smithy.api#documentation": "Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.
If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.
\n If you specify a value for\n IPAddress:
Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes\n\t\t\tthe value of FullyQualifiedDomainName in the Host header for\n\t\t\tall health checks except TCP health checks. This is typically the fully qualified DNS\n\t\t\tname of the endpoint on which you want Route 53 to perform health checks.
When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:
If you specify a value of 80 for Port and\n\t\t\t\t\t\tHTTP or HTTP_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify a value of 443 for Port and\n\t\t\t\t\t\tHTTPS or HTTPS_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify another value for Port and any value except\n\t\t\t\t\t\tTCP for Type, Route 53 passes\n\t\t\t\t\t\t\t\n FullyQualifiedDomainName:Port\n \n\t\t\t\t\tto the endpoint in the Host header.
If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the above cases.
\n If you don't specify a value for\n IPAddress:
If you don't specify a value for IPAddress, Route 53 sends a DNS request\n\t\t\tto the domain that you specify in FullyQualifiedDomainName at the interval\n\t\t\tyou specify in RequestInterval. Using an IPv4 address that is returned by\n\t\t\tDNS, Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.
If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record\n\t\t\tsets (www.example.com).
In this configuration, if the value of FullyQualifiedDomainName\n\t\t\t\tmatches the name of the resource record sets and you then associate the health check\n\t\t\t\twith those resource record sets, health check results will be unpredictable.
In addition, if the value of Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.
If the value of Type is HTTP_STR_MATCH or\n\t\t\t\tHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for\n\t\t\tin the response body from the specified resource. If the string appears in the response\n\t\t\tbody, Route 53 considers the resource healthy. (You can't change the value of\n\t\t\t\tType when you update a health check.)
The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.
Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.
" - } - }, - "Disabled": { - "target": "com.amazonaws.route53#Disabled", - "traits": { - "smithy.api#documentation": "Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:
\n\n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.
\n\n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.
\n\n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.
\nAfter you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.
\nCharges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.
" - } - }, - "HealthThreshold": { - "target": "com.amazonaws.route53#HealthThreshold", - "traits": { - "smithy.api#documentation": "The number of child health checks that are associated with a CALCULATED\n\t\t\thealth that Amazon Route 53 must consider healthy for the CALCULATED health\n\t\t\tcheck to be considered healthy. To specify the child health checks that you want to\n\t\t\tassociate with a CALCULATED health check, use the\n\t\t\t\tChildHealthChecks and ChildHealthCheck elements.
Note the following:
\nIf you specify a number greater than the number of child health checks, Route\n\t\t\t\t\t53 always considers this health check to be unhealthy.
\nIf you specify 0, Route 53 always considers this health check to\n\t\t\t\t\tbe healthy.
A complex type that contains one ChildHealthCheck element for each health\n\t\t\tcheck that you want to associate with a CALCULATED health check.
Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows\n\t\t\tthe endpoint to respond to HTTPS health check requests with the applicable\n\t\t\tSSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.
A complex type that contains one Region element for each region that you\n\t\t\twant Amazon Route 53 health checkers to check the specified endpoint from.
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.
" - } - }, - "InsufficientDataHealthStatus": { - "target": "com.amazonaws.route53#InsufficientDataHealthStatus", - "traits": { - "smithy.api#documentation": "When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:
\n\n Healthy: Route 53 considers the health check to be\n\t\t\t\t\thealthy.
\n Unhealthy: Route 53 considers the health check to be\n\t\t\t\t\tunhealthy.
\n LastKnownStatus: By default, Route 53 uses the status of the\n\t\t\t\t\thealth check from the last time CloudWatch had sufficient data to determine the\n\t\t\t\t\talarm state. For new health checks that have no last known status, the status\n\t\t\t\t\tfor the health check is healthy.
A complex type that contains one ResettableElementName element for each\n\t\t\telement that you want to reset to the default value. Valid values for\n\t\t\t\tResettableElementName include the following:
\n ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null.
\n FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null.
\n Regions: Route 53 resets the Regions list to the default set of regions.
\n ResourcePath: Route 53 resets ResourcePath to null.
A complex type that contains information about a request to update a health\n\t\t\tcheck.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateHealthCheckResponse": { - "type": "structure", - "members": { - "HealthCheck": { - "target": "com.amazonaws.route53#HealthCheck", - "traits": { - "smithy.api#documentation": "A complex type that contains the response to an UpdateHealthCheck\n\t\t\trequest.
A complex type that contains the response to the UpdateHealthCheck\n\t\t\trequest.
Updates the comment for a specified hosted zone.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/hostedzone/{Id}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateHostedZoneCommentRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#ResourceId", - "traits": { - "smithy.api#documentation": "The ID for the hosted zone that you want to update the comment for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.route53#ResourceDescription", - "traits": { - "smithy.api#documentation": "The new comment for the hosted zone. If you don't specify a value for\n\t\t\t\tComment, Amazon Route 53 deletes the existing value of the\n\t\t\t\tComment element, if any.
A request to update the comment for a hosted zone.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateHostedZoneCommentResponse": { - "type": "structure", - "members": { - "HostedZone": { - "target": "com.amazonaws.route53#HostedZone", - "traits": { - "smithy.api#documentation": "A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.
A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.
Updates the comment for a specified traffic policy version.
", - "smithy.api#http": { - "method": "POST", - "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", - "code": 200 - } - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "The value of Id for the traffic policy that you want to update the\n\t\t\tcomment for.
The value of Version for the traffic policy that you want to update the\n\t\t\tcomment for.
The new comment for the specified traffic policy and version.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the traffic policy that you want to\n\t\t\tupdate the comment for.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse": { - "type": "structure", - "members": { - "TrafficPolicy": { - "target": "com.amazonaws.route53#TrafficPolicy", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the specified traffic policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains the response information for the traffic policy.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest" - }, - "output": { - "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.route53#ConflictingTypes" - }, - { - "target": "com.amazonaws.route53#InvalidInput" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicy" - }, - { - "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" - }, - { - "target": "com.amazonaws.route53#PriorRequestNotComplete" - } - ], - "traits": { - "smithy.api#documentation": "After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.
Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.
\nWhen you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:
\nRoute 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t
\nWhen all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.
\nRoute 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.
\nThe ID of the traffic policy instance that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TTL": { - "target": "com.amazonaws.route53#TTL", - "traits": { - "smithy.api#documentation": "The TTL that you want Amazon Route 53 to assign to all of the updated resource record\n\t\t\tsets.
", - "smithy.api#required": {} - } - }, - "TrafficPolicyId": { - "target": "com.amazonaws.route53#TrafficPolicyId", - "traits": { - "smithy.api#documentation": "The ID of the traffic policy that you want Amazon Route 53 to use to update resource\n\t\t\trecord sets for the specified traffic policy instance.
", - "smithy.api#required": {} - } - }, - "TrafficPolicyVersion": { - "target": "com.amazonaws.route53#TrafficPolicyVersion", - "traits": { - "smithy.api#documentation": "The version of the traffic policy that you want Amazon Route 53 to use to update\n\t\t\tresource record sets for the specified traffic policy instance.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the resource record sets that you want\n\t\t\tto update based on a specified traffic policy instance.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse": { - "type": "structure", - "members": { - "TrafficPolicyInstance": { - "target": "com.amazonaws.route53#TrafficPolicyInstance", - "traits": { - "smithy.api#documentation": "A complex type that contains settings for the updated traffic policy instance.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.route53#UsageCount": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.route53#VPC": { - "type": "structure", - "members": { - "VPCRegion": { - "target": "com.amazonaws.route53#VPCRegion", - "traits": { - "smithy.api#documentation": "(Private hosted zones only) The region that an Amazon VPC was created\n\t\t\tin.
" - } - }, - "VPCId": { - "target": "com.amazonaws.route53#VPCId" - } - }, - "traits": { - "smithy.api#documentation": "(Private hosted zones only) A complex type that contains information about an Amazon VPC.
\nIf you associate a private hosted zone with an Amazon VPC when you make a\n\t\t\t\tCreateHostedZone\n\t\t\trequest, the following parameters are also required.
" - } - }, - "com.amazonaws.route53#VPCAssociationAuthorizationNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "" - } - } - }, - "traits": { - "smithy.api#documentation": "The VPC that you specified is not authorized to be associated with the hosted\n\t\t\tzone.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#VPCAssociationNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.route53#ErrorMessage", - "traits": { - "smithy.api#documentation": "The specified VPC or hosted zone weren't found.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The specified VPC and hosted zone are not currently associated.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.route53#VPCId": { - "type": "string", - "traits": { - "smithy.api#documentation": "(Private hosted zones only) The ID of an Amazon VPC.
", - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.route53#VPCRegion": { - "type": "enum", - "members": { - "us_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-1" - } - }, - "us_east_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-east-2" - } - }, - "us_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-1" - } - }, - "us_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-west-2" - } - }, - "eu_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-1" - } - }, - "eu_west_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-2" - } - }, - "eu_west_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-west-3" - } - }, - "eu_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-1" - } - }, - "eu_central_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-central-2" - } - }, - "ap_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-east-1" - } - }, - "me_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-south-1" - } - }, - "us_gov_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-west-1" - } - }, - "us_gov_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-gov-east-1" - } - }, - "us_iso_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-east-1" - } - }, - "us_iso_west_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-iso-west-1" - } - }, - "us_isob_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "us-isob-east-1" - } - }, - "me_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "me-central-1" - } - }, - "ap_southeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-1" - } - }, - "ap_southeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-2" - } - }, - "ap_southeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-3" - } - }, - "ap_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-1" - } - }, - "ap_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-south-2" - } - }, - "ap_northeast_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-1" - } - }, - "ap_northeast_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-2" - } - }, - "ap_northeast_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-northeast-3" - } - }, - "eu_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-north-1" - } - }, - "sa_east_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "sa-east-1" - } - }, - "ca_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ca-central-1" - } - }, - "cn_north_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cn-north-1" - } - }, - "af_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "af-south-1" - } - }, - "eu_south_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-1" - } - }, - "eu_south_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "eu-south-2" - } - }, - "ap_southeast_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ap-southeast-4" - } - }, - "il_central_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "il-central-1" - } - } - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.route53#VPCs": { - "type": "list", - "member": { - "target": "com.amazonaws.route53#VPC", - "traits": { - "smithy.api#xmlName": "VPC" - } - }, - "traits": { - "smithy.api#documentation": "(Private hosted zones only) A list of VPC elements.
Creates a new health check.
\nFor information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.
\n\n ELB Load Balancers\n
\nIf you're registering EC2 instances with an Elastic Load Balancing (ELB) load\n\t\t\tbalancer, do not create Amazon Route 53 health checks for the EC2 instances. When you\n\t\t\tregister an EC2 instance with a load balancer, you configure settings for an ELB health\n\t\t\tcheck, which performs a similar function to a Route 53 health check.
\n\n Private Hosted Zones\n
\nYou can associate health checks with failover resource record sets in a private hosted\n\t\t\tzone. Note the following:
\nRoute 53 health checkers are outside the VPC. To check the health of an\n\t\t\t\t\tendpoint within a VPC by IP address, you must assign a public IP address to the\n\t\t\t\t\tinstance in the VPC.
\nYou can configure a health checker to check the health of an external resource\n\t\t\t\t\tthat the instance relies on, such as a database server.
\nYou can create a CloudWatch metric, associate an alarm with the metric, and\n\t\t\t\t\tthen create a health check that is based on the state of the alarm. For example,\n\t\t\t\t\tyou might create a CloudWatch metric that checks the status of the Amazon EC2\n\t\t\t\t\t\tStatusCheckFailed metric, add an alarm to the metric, and then\n\t\t\t\t\tcreate a health check that is based on the state of the alarm. For information\n\t\t\t\t\tabout creating CloudWatch metrics and alarms by using the CloudWatch console,\n\t\t\t\t\tsee the Amazon\n\t\t\t\t\t\tCloudWatch User Guide.
A unique string that identifies the request and that allows you to retry a failed\n\t\t\t\tCreateHealthCheck request without the risk of creating two identical\n\t\t\thealth checks:
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference and settings as a previous request, and if the\n\t\t\t\t\thealth check doesn't exist, Amazon Route 53 creates the health check. If the\n\t\t\t\t\thealth check does exist, Route 53 returns the settings for the existing health\n\t\t\t\t\tcheck.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as a deleted health check, regardless of the\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with the same\n\t\t\t\t\t\tCallerReference as an existing health check but with different\n\t\t\t\t\tsettings, Route 53 returns a HealthCheckAlreadyExists error.
If you send a CreateHealthCheck request with a unique\n\t\t\t\t\t\tCallerReference but settings identical to an existing health\n\t\t\t\t\tcheck, Route 53 creates the health check.
Route 53 does not store the CallerReference for a deleted health check indefinitely. \n\t\t\tThe CallerReference for a deleted health check will be deleted after a number of days.
A complex type that contains settings for a new health check.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the health check request information.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "A complex type that contains identifying information about the health check.
", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "The unique URL representing the new health check.
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type containing the response information for the new health check.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingDomainExists" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotAvailable" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#HostedZoneAlreadyExists" + }, + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + }, + { + "target": "com.amazonaws.route53#TooManyHostedZones" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new public or private hosted zone. You create records in a public hosted\n\t\t\tzone to define how you want to route traffic on the internet for a domain, such as\n\t\t\texample.com, and its subdomains (apex.example.com, acme.example.com). You create records\n\t\t\tin a private hosted zone to define how you want to route traffic for a domain and its\n\t\t\tsubdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).
\nYou can't convert a public hosted zone to a private hosted zone or vice versa.\n\t\t\t\tInstead, you must create a new hosted zone with the same name and create new\n\t\t\t\tresource record sets.
\nFor more information about charges for hosted zones, see Amazon Route 53 Pricing.
\nNote the following:
\nYou can't create a hosted zone for a top-level domain (TLD) such as\n\t\t\t\t\t.com.
\nFor public hosted zones, Route 53 automatically creates a default SOA record\n\t\t\t\t\tand four NS records for the zone. For more information about SOA and NS records,\n\t\t\t\t\tsee NS and SOA Records\n\t\t\t\t\t\tthat Route 53 Creates for a Hosted Zone in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you want to use the same name servers for multiple public hosted zones, you\n\t\t\t\t\tcan optionally associate a reusable delegation set with the hosted zone. See the\n\t\t\t\t\t\tDelegationSetId element.
If your domain is registered with a registrar other than Route 53,\n\t\t\t\t\tyou must update the name servers with your registrar to make Route 53 the DNS\n\t\t\t\t\tservice for the domain. For more information, see Migrating DNS Service\n\t\t\t\t\t\tfor an Existing Domain to Amazon Route 53 in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nWhen you submit a CreateHostedZone request, the initial status of the\n\t\t\thosted zone is PENDING. For public hosted zones, this means that the NS and\n\t\t\tSOA records are not yet available on all Route 53 DNS servers. When the NS and\n\t\t\tSOA records are available, the status of the zone changes to INSYNC.
The CreateHostedZone request requires the caller to have an\n\t\t\t\tec2:DescribeVpcs permission.
When creating private hosted zones, the Amazon VPC must belong to the same\n\t\t\t\tpartition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one\n\t\t\t\tpartition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe name of the domain. Specify a fully qualified domain name, for example,\n\t\t\t\twww.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that\n\t\t\t\tRoute 53 treats www.example.com (without a trailing\n\t\t\tdot) and www.example.com. (with a trailing dot) as\n\t\t\tidentical.
\nIf you're creating a public hosted zone, this is the name you have registered with\n\t\t\tyour DNS registrar. If your domain name is registered with a registrar other than\n\t\t\t\tRoute 53, change the name servers for your domain to the set of\n\t\t\t\tNameServers that CreateHostedZone returns in\n\t\t\t\tDelegationSet.
(Private hosted zones only) A complex type that contains information about the Amazon\n\t\t\tVPC that you're associating with this hosted zone.
\nYou can specify only one Amazon VPC when you create a private hosted zone. If you are\n\t\t\tassociating a VPC with a hosted zone with this request, the paramaters\n\t\t\t\tVPCId and VPCRegion are also required.
To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.
" + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "A unique string that identifies the request and that allows failed\n\t\t\t\tCreateHostedZone requests to be retried without the risk of executing\n\t\t\tthe operation twice. You must use a unique CallerReference string every\n\t\t\ttime you submit a CreateHostedZone request. CallerReference\n\t\t\tcan be any unique string, for example, a date/time stamp.
(Optional) A complex type that contains the following optional values:
\nFor public and private hosted zones, an optional comment
\nFor private hosted zones, an optional PrivateZone element
If you don't specify a comment or the PrivateZone element, omit\n\t\t\t\tHostedZoneConfig and the other elements.
If you want to associate a reusable delegation set with this hosted zone, the ID that\n\t\t\t\tAmazon Route 53 assigned to the reusable delegation set when you created it.\n\t\t\tFor more information about reusable delegation sets, see CreateReusableDelegationSet.
\nIf you are using a reusable delegation set to create a public hosted zone for a subdomain,\n\t\t\tmake sure that the parent hosted zone doesn't use one or more of the same name servers.\n\t\t\tIf you have overlapping nameservers, the operation will cause a\n\t\t\t\tConflictingDomainsExist error.
A complex type that contains information about the request to create a public or\n\t\t\tprivate hosted zone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateHostedZoneResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
", + "smithy.api#required": {} + } + }, + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the CreateHostedZone\n\t\t\trequest.
A complex type that describes the name servers for this hosted zone.
", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "A complex type that contains information about an Amazon VPC that you associated with\n\t\t\tthis hosted zone.
" + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "The unique URL representing the new hosted zone.
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type containing the response information for the hosted zone.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyName" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyAlreadyExists" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#TooManyKeySigningKeys" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new key-signing key (KSK) associated with a hosted zone. You can only have\n\t\t\ttwo KSKs per hosted zone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/keysigningkey", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateKeySigningKeyRequest": { + "type": "structure", + "members": { + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "A unique string that identifies the request.
", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The unique string (ID) used to identify a hosted zone.
", + "smithy.api#required": {} + } + }, + "KeyManagementServiceArn": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "The Amazon resource name (ARN) for a customer managed key in Key Management Service\n\t\t\t\t(KMS). The KeyManagementServiceArn must be unique for\n\t\t\teach key-signing key (KSK) in a single hosted zone. To see an example of\n\t\t\t\tKeyManagementServiceArn that grants the correct permissions for DNSSEC,\n\t\t\tscroll down to Example.
You must configure the customer managed customer managed key as follows:
\nEnabled
\nECC_NIST_P256
\nSign and verify
\nThe key policy must give permission for the following actions:
\nDescribeKey
\nGetPublicKey
\nSign
\nThe key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:
\n\n \"Service\": \"dnssec-route53.amazonaws.com\"\n
For more information about working with a customer managed key in KMS, see Key Management Service concepts.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.
A string specifying the initial status of the key-signing key (KSK). You can set the\n\t\t\tvalue to ACTIVE or INACTIVE.
The key-signing key (KSK) that the request creates.
", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "The unique URL representing the new key-signing key (KSK).
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#QueryLoggingConfigAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "Creates a configuration for DNS query logging. After you create a query logging\n\t\t\tconfiguration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs\n\t\t\tlog group.
\nDNS query logs contain information about the queries that Route 53 receives for a\n\t\t\tspecified public hosted zone, such as the following:
\nRoute 53 edge location that responded to the DNS query
\nDomain or subdomain that was requested
\nDNS record type, such as A or AAAA
\nDNS response code, such as NoError or\n\t\t\t\t\tServFail\n
Before you create a query logging configuration, perform the following\n\t\t\t\t\t\toperations.
\nIf you create a query logging configuration using the Route 53\n\t\t\t\t\t\t\tconsole, Route 53 performs these operations automatically.
\nCreate a CloudWatch Logs log group, and make note of the ARN,\n\t\t\t\t\t\t\t\twhich you specify when you create a query logging configuration.\n\t\t\t\t\t\t\t\tNote the following:
\nYou must create the log group in the us-east-1\n\t\t\t\t\t\t\t\t\t\tregion.
\nYou must use the same Amazon Web Services account to create\n\t\t\t\t\t\t\t\t\t\tthe log group and the hosted zone that you want to configure\n\t\t\t\t\t\t\t\t\t\tquery logging for.
\nWhen you create log groups for query logging, we recommend\n\t\t\t\t\t\t\t\t\t\tthat you use a consistent prefix, for example:
\n\n /aws/route53/hosted zone\n\t\t\t\t\t\t\t\t\t\t\tname\n \n
In the next step, you'll create a resource policy, which\n\t\t\t\t\t\t\t\t\t\tcontrols access to one or more log groups and the associated\n\t\t\t\t\t\t\t\t\t\t\tAmazon Web Services resources, such as Route 53 hosted\n\t\t\t\t\t\t\t\t\t\tzones. There's a limit on the number of resource policies\n\t\t\t\t\t\t\t\t\t\tthat you can create, so we recommend that you use a\n\t\t\t\t\t\t\t\t\t\tconsistent prefix so you can use the same resource policy\n\t\t\t\t\t\t\t\t\t\tfor all the log groups that you create for query\n\t\t\t\t\t\t\t\t\t\tlogging.
\nCreate a CloudWatch Logs resource policy, and give it the\n\t\t\t\t\t\t\t\tpermissions that Route 53 needs to create log streams and to send\n\t\t\t\t\t\t\t\tquery logs to log streams. For the value of Resource,\n\t\t\t\t\t\t\t\tspecify the ARN for the log group that you created in the previous\n\t\t\t\t\t\t\t\tstep. To use the same resource policy for all the CloudWatch Logs\n\t\t\t\t\t\t\t\tlog groups that you created for query logging configurations,\n\t\t\t\t\t\t\t\treplace the hosted zone name with *, for\n\t\t\t\t\t\t\t\texample:
\n arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*\n
To avoid the confused deputy problem, a security issue where an\n\t\t\t\t\t\t\t\tentity without a permission for an action can coerce a\n\t\t\t\t\t\t\t\tmore-privileged entity to perform it, you can optionally limit the\n\t\t\t\t\t\t\t\tpermissions that a service has to a resource in a resource-based\n\t\t\t\t\t\t\t\tpolicy by supplying the following values:
\nFor aws:SourceArn, supply the hosted zone ARN\n\t\t\t\t\t\t\t\t\t\tused in creating the query logging configuration. For\n\t\t\t\t\t\t\t\t\t\texample, aws:SourceArn:\n\t\t\t\t\t\t\t\t\t\t\tarn:aws:route53:::hostedzone/hosted zone\n\t\t\t\t\t\t\t\t\t\tID.
For aws:SourceAccount, supply the account ID\n\t\t\t\t\t\t\t\t\t\tfor the account that creates the query logging\n\t\t\t\t\t\t\t\t\t\tconfiguration. For example,\n\t\t\t\t\t\t\t\t\t\t\taws:SourceAccount:111111111111.
For more information, see The confused\n\t\t\t\t\t\t\t\t\tdeputy problem in the Amazon Web Services\n\t\t\t\t\t\t\t\t\tIAM User Guide.
\nYou can't use the CloudWatch console to create or edit a\n\t\t\t\t\t\t\t\t\tresource policy. You must use the CloudWatch API, one of the\n\t\t\t\t\t\t\t\t\t\tAmazon Web Services SDKs, or the CLI.
\nWhen Route 53 finishes creating the configuration for DNS query logging,\n\t\t\t\t\t\tit does the following:
\nCreates a log stream for an edge location the first time that the\n\t\t\t\t\t\t\t\tedge location responds to DNS queries for the specified hosted zone.\n\t\t\t\t\t\t\t\tThat log stream is used to log all queries that Route 53 responds to\n\t\t\t\t\t\t\t\tfor that edge location.
\nBegins to send query logs to the applicable log stream.
\nThe name of each log stream is in the following format:
\n\n \n hosted zone ID/edge location\n\t\t\t\t\t\t\t\tcode\n \n
The edge location code is a three-letter code and an arbitrarily assigned\n\t\t\t\t\t\tnumber, for example, DFW3. The three-letter code typically corresponds with\n\t\t\t\t\t\tthe International Air Transport Association airport code for an airport near\n\t\t\t\t\t\tthe edge location. (These abbreviations might change in the future.) For a\n\t\t\t\t\t\tlist of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details\n\t\t\t\t\t\tpage.
\nQuery logs contain only the queries that DNS resolvers forward to Route\n\t\t\t\t\t\t53. If a DNS resolver has already cached the response to a query (such as\n\t\t\t\t\t\tthe IP address for a load balancer for example.com), the resolver will\n\t\t\t\t\t\tcontinue to return the cached response. It doesn't forward another query to\n\t\t\t\t\t\tRoute 53 until the TTL for the corresponding resource record set expires.\n\t\t\t\t\t\tDepending on how many DNS queries are submitted for a resource record set,\n\t\t\t\t\t\tand depending on the TTL for that resource record set, query logs might\n\t\t\t\t\t\tcontain information about only one query out of every several thousand\n\t\t\t\t\t\tqueries that are submitted to DNS. For more information about how DNS works,\n\t\t\t\t\t\tsee Routing\n\t\t\t\t\t\t\tInternet Traffic to Your Website or Web Application in the\n\t\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nFor a list of the values in each query log and the format of each value,\n\t\t\t\t\t\tsee Logging DNS\n\t\t\t\t\t\t\tQueries in the Amazon Route 53 Developer\n\t\t\t\t\t\t\tGuide.
\nFor information about charges for query logs, see Amazon CloudWatch Pricing.
\nIf you want Route 53 to stop sending query logs to CloudWatch Logs, delete\n\t\t\t\t\t\tthe query logging configuration. For more information, see DeleteQueryLoggingConfig.
\nThe ID of the hosted zone that you want to log queries for. You can log queries only\n\t\t\tfor public hosted zones.
", + "smithy.api#required": {} + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to\n\t\t\tsend query logs to. This is the format of the ARN:
\narn:aws:logs:region:account-id:log-group:log_group_name\n
\nTo get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups\n\t\t\tcommand, or the applicable command in one of the Amazon Web Services SDKs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateQueryLoggingConfigResponse": { + "type": "structure", + "members": { + "QueryLoggingConfig": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#documentation": "A complex type that contains the ID for a query logging configuration, the ID of the\n\t\t\thosted zone that you want to log queries for, and the ARN for the log group that you\n\t\t\twant Amazon Route 53 to send query logs to.
", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "The unique URL representing the new query logging configuration.
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetAlreadyCreated" + }, + { + "target": "com.amazonaws.route53#DelegationSetAlreadyReusable" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotAvailable" + }, + { + "target": "com.amazonaws.route53#HostedZoneNotFound" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#LimitsExceeded" + } + ], + "traits": { + "smithy.api#documentation": "Creates a delegation set (a group of four name servers) that can be reused by multiple\n\t\t\thosted zones that were created by the same Amazon Web Services account.
\nYou can also create a reusable delegation set that uses the four name servers that are\n\t\t\tassociated with an existing hosted zone. Specify the hosted zone ID in the\n\t\t\t\tCreateReusableDelegationSet request.
You can't associate a reusable delegation set with a private hosted zone.
\nFor information about using a reusable delegation set to configure white label name\n\t\t\tservers, see Configuring White\n\t\t\t\tLabel Name Servers.
\nThe process for migrating existing hosted zones to use a reusable delegation set is\n\t\t\tcomparable to the process for configuring white label name servers. You need to perform\n\t\t\tthe following steps:
\nCreate a reusable delegation set.
\nRecreate hosted zones, and reduce the TTL to 60 seconds or less.
\nRecreate resource record sets in the new hosted zones.
\nChange the registrar's name servers to use the name servers for the new hosted\n\t\t\t\t\tzones.
\nMonitor traffic for the website or application.
\nChange TTLs back to their original values.
\nIf you want to migrate existing hosted zones to use a reusable delegation set, the\n\t\t\texisting hosted zones can't use any of the name servers that are assigned to the\n\t\t\treusable delegation set. If one or more hosted zones do use one or more name servers\n\t\t\tthat are assigned to the reusable delegation set, you can do one of the\n\t\t\tfollowing:
\nFor small numbers of hosted zones—up to a few hundred—it's\n\t\t\t\t\trelatively easy to create reusable delegation sets until you get one that has\n\t\t\t\t\tfour name servers that don't overlap with any of the name servers in your hosted\n\t\t\t\t\tzones.
\nFor larger numbers of hosted zones, the easiest solution is to use more than\n\t\t\t\t\tone reusable delegation set.
\nFor larger numbers of hosted zones, you can also migrate hosted zones that\n\t\t\t\t\thave overlapping name servers to hosted zones that don't have overlapping name\n\t\t\t\t\tservers, then migrate the hosted zones again to use the reusable delegation\n\t\t\t\t\tset.
\nA unique string that identifies the request, and that allows you to retry failed\n\t\t\t\tCreateReusableDelegationSet requests without the risk of executing the\n\t\t\toperation twice. You must use a unique CallerReference string every time\n\t\t\tyou submit a CreateReusableDelegationSet request.\n\t\t\t\tCallerReference can be any unique string, for example a date/time\n\t\t\tstamp.
If you want to mark the delegation set for an existing hosted zone as reusable, the ID\n\t\t\tfor that hosted zone.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateReusableDelegationSetResponse": { + "type": "structure", + "members": { + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "A complex type that contains name server information.
", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "The unique URL representing the new reusable delegation set.
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidTrafficPolicyDocument" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicies" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "Creates a traffic policy, which you use to create multiple DNS resource record sets\n\t\t\tfor one domain name (such as example.com) or one subdomain name (such as\n\t\t\twww.example.com).
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TooManyTrafficPolicyInstances" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists" + } + ], + "traits": { + "smithy.api#documentation": "Creates resource record sets in a specified hosted zone based on the settings in a\n\t\t\tspecified traffic policy version. In addition, CreateTrafficPolicyInstance\n\t\t\tassociates the resource record sets with a specified domain name (such as example.com)\n\t\t\tor subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for\n\t\t\tthe domain or subdomain name by using the resource record sets that\n\t\t\t\tCreateTrafficPolicyInstance created.
After you submit an CreateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. \n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the CreateTrafficPolicyInstance\n\t\t\t\trequest completed successfully. For more information, see the\n\t\t\t\tState response element.
The ID of the hosted zone that you want Amazon Route 53 to create resource record sets\n\t\t\tin by using the configuration in a traffic policy.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "The domain name (such as example.com) or subdomain name (such as www.example.com) for\n\t\t\twhich Amazon Route 53 responds to DNS queries by using the resource record sets that\n\t\t\tRoute 53 creates for this traffic policy instance.
", + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource\n\t\t\trecord sets that it creates in the specified hosted zone.
", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "The ID of the traffic policy that you want to use to create resource record sets in\n\t\t\tthe specified hosted zone.
", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version of the traffic policy that you want to use to create resource record sets\n\t\t\tin the specified hosted zone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the resource record sets that you want\n\t\t\tto create based on a specified traffic policy.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the new traffic policy instance.
", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "A unique URL that represents a new traffic policy instance.
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyInstance request.
The name of the traffic policy.
", + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.
", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#TrafficPolicyComment", + "traits": { + "smithy.api#documentation": "(Optional) Any comments that you want to include about the traffic policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the new traffic policy.
", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "A unique URL that represents a new traffic policy.
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicy request.
Creates a new version of an existing traffic policy. When you create a new version of\n\t\t\ta traffic policy, you specify the ID of the traffic policy that you want to update and a\n\t\t\tJSON-formatted document that describes the new version. You use traffic policies to\n\t\t\tcreate multiple DNS resource record sets for one domain name (such as example.com) or\n\t\t\tone subdomain name (such as www.example.com). You can create a maximum of 1000 versions\n\t\t\tof a traffic policy. If you reach the limit and need to create another version, you'll\n\t\t\tneed to start a new traffic policy.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy/{Id}", + "code": 201 + } + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "The ID of the traffic policy for which you want to create a new version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "The definition of this version of the traffic policy, in JSON format. You specified\n\t\t\tthe JSON in the CreateTrafficPolicyVersion request. For more information\n\t\t\tabout the JSON format, see CreateTrafficPolicy.
The comment that you specified in the CreateTrafficPolicyVersion request,\n\t\t\tif any.
A complex type that contains information about the traffic policy that you want to\n\t\t\tcreate a new version for.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateTrafficPolicyVersionResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the new version of the traffic\n\t\t\tpolicy.
", + "smithy.api#required": {} + } + }, + "Location": { + "target": "com.amazonaws.route53#ResourceURI", + "traits": { + "smithy.api#documentation": "A unique URL that represents a new traffic policy version.
", + "smithy.api#httpHeader": "Location", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the\n\t\t\t\tCreateTrafficPolicyVersion request.
Authorizes the Amazon Web Services account that created a specified VPC to submit an\n\t\t\t\tAssociateVPCWithHostedZone request to associate the VPC with a\n\t\t\tspecified hosted zone that was created by a different account. To submit a\n\t\t\t\tCreateVPCAssociationAuthorization request, you must use the account\n\t\t\tthat created the hosted zone. After you authorize the association, use the account that\n\t\t\tcreated the VPC to submit an AssociateVPCWithHostedZone request.
If you want to associate multiple VPCs that you created by using one account with\n\t\t\t\ta hosted zone that you created by using a different account, you must submit one\n\t\t\t\tauthorization request for each VPC.
\nThe ID of the private hosted zone that you want to authorize associating a VPC\n\t\t\twith.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "A complex type that contains the VPC ID and region for the VPC that you want to\n\t\t\tauthorize associating with your hosted zone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the request to authorize associating a\n\t\t\tVPC with your private hosted zone. Authorization is only required when a private hosted\n\t\t\tzone and a VPC were created by using different accounts.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#CreateVPCAssociationAuthorizationResponse": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the hosted zone that you authorized associating a VPC with.
", + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "The VPC that you authorized associating with a hosted zone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information from a\n\t\t\t\tCreateVPCAssociationAuthorization request.
The hosted zone doesn't have any DNSSEC resources.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#DNSSECStatus": { + "type": "structure", + "members": { + "ServeSignature": { + "target": "com.amazonaws.route53#ServeSignature", + "traits": { + "smithy.api#documentation": "A string that represents the current hosted zone signing status.
\nStatus can have one of the following values:
\nDNSSEC signing is enabled for the hosted zone.
\nDNSSEC signing is not enabled for the hosted zone.
\nDNSSEC signing is in the process of being removed for the hosted\n\t\t\t\t\t\tzone.
\nThere is a problem with signing in the hosted zone that requires you to\n\t\t\t\t\t\ttake action to resolve. For example, the customer managed key might have\n\t\t\t\t\t\tbeen deleted, or the permissions for the customer managed key might have\n\t\t\t\t\t\tbeen changed.
\nThere was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including with key-signing keys (KSKs), you must correct the\n\t\t\t\t\t\tproblem by enabling or disabling DNSSEC signing for the hosted zone.
\nThe status message provided for the following DNSSEC signing status:\n\t\t\t\tINTERNAL_FAILURE. The status message includes information about what\n\t\t\tthe problem might be and steps that you can take to correct the issue.
A string repesenting the status of DNSSEC signing.
" + } + }, + "com.amazonaws.route53#DeactivateKeySigningKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeactivateKeySigningKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidSigningStatus" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInUse" + }, + { + "target": "com.amazonaws.route53#NoSuchKeySigningKey" + } + ], + "traits": { + "smithy.api#documentation": "Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.\n\t\t\tThis operation changes the KSK status to INACTIVE.
A unique string used to identify a hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "A string used to identify a key-signing key (KSK).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeactivateKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DelegationSet": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID that Amazon Route 53 assigns to a reusable delegation set.
" + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#Nonce", + "traits": { + "smithy.api#documentation": "The value that you specified for CallerReference when you created the\n\t\t\treusable delegation set.
A complex type that contains a list of the authoritative name servers for a hosted\n\t\t\tzone or for a reusable delegation set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that lists the name servers in a delegation set, as well as the\n\t\t\t\tCallerReference and the ID for the delegation set.
A delegation set with the same owner and caller reference combination has already been\n\t\t\tcreated.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetAlreadyReusable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified delegation set has already been marked as reusable.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified delegation contains associated hosted zones which must be deleted before\n\t\t\tthe reusable delegation set can be deleted.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetNameServers": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#xmlName": "NameServer" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.route53#DelegationSetNotAvailable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "You can create a hosted zone that has the same name as an existing hosted zone\n\t\t\t(example.com is common), but there is a limit to the number of hosted zones that have\n\t\t\tthe same name. If you get this error, Amazon Route 53 has reached that limit. If you own\n\t\t\tthe domain name and Route 53 generates this error, contact Customer Support.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSetNotReusable": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "A reusable delegation set with the specified ID does not exist.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#DelegationSets": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#xmlName": "DelegationSet" + } + } + }, + "com.amazonaws.route53#DeleteCidrCollection": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteCidrCollectionRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteCidrCollectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#CidrCollectionInUseException" + }, + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a CIDR collection in the current Amazon Web Services account. The collection\n\t\t\tmust be empty before it can be deleted.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/cidrcollection/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteCidrCollectionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "The UUID of the collection to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteCidrCollectionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckInUse" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a health check.
\nAmazon Route 53 does not prevent you from deleting a health check even if the\n\t\t\t\thealth check is associated with one or more resource record sets. If you delete a\n\t\t\t\thealth check and you don't update the associated resource record sets, the future\n\t\t\t\tstatus of the health check can't be predicted and may change. This will affect the\n\t\t\t\trouting of DNS queries for your DNS failover configuration. For more information,\n\t\t\t\tsee Replacing and Deleting Health Checks in the Amazon Route 53\n\t\t\t\t\tDeveloper Guide.
\nIf you're using Cloud Map and you configured Cloud Map to create a Route 53\n\t\t\thealth check when you register an instance, you can't use the Route 53\n\t\t\t\tDeleteHealthCheck command to delete the health check. The health check\n\t\t\tis deleted automatically when you deregister the instance; there can be a delay of\n\t\t\tseveral hours before the health check is deleted from Route 53.
The ID of the health check that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This action deletes a health check.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteHealthCheckResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "An empty element.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HostedZoneNotEmpty" + }, + { + "target": "com.amazonaws.route53#InvalidDomainName" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a hosted zone.
\nIf the hosted zone was created by another service, such as Cloud Map, see\n\t\t\t\tDeleting Public Hosted Zones That Were Created by Another Service in the\n\t\t\t\t\tAmazon Route 53 Developer Guide for information\n\t\t\tabout how to delete it. (The process is the same for public and private hosted zones\n\t\t\tthat were created by another service.)
\nIf you want to keep your domain registration but you want to stop routing internet\n\t\t\ttraffic to your website or web application, we recommend that you delete resource record\n\t\t\tsets in the hosted zone instead of deleting the hosted zone.
\nIf you delete a hosted zone, you can't undelete it. You must create a new hosted\n\t\t\t\tzone and update the name servers for your domain registration, which can require up\n\t\t\t\tto 48 hours to take effect. (If you delegated responsibility for a subdomain to a\n\t\t\t\thosted zone and you delete the child hosted zone, you must update the name servers\n\t\t\t\tin the parent hosted zone.) In addition, if you delete a hosted zone, someone could\n\t\t\t\thijack the domain and route traffic to their own resources using your domain\n\t\t\t\tname.
\nIf you want to avoid the monthly charge for the hosted zone, you can transfer DNS\n\t\t\tservice for the domain to a free DNS service. When you transfer DNS service, you have to\n\t\t\tupdate the name servers for the domain registration. If the domain is registered with\n\t\t\t\tRoute 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is\n\t\t\tregistered with another registrar, use the method provided by the registrar to update\n\t\t\tname servers for the domain registration. For more information, perform an internet\n\t\t\tsearch on \"free DNS service.\"
\nYou can delete a hosted zone only if it contains only the default SOA record and NS\n\t\t\tresource record sets. If the hosted zone contains other resource record sets, you must\n\t\t\tdelete them before you can delete the hosted zone. If you try to delete a hosted zone\n\t\t\tthat contains other resource record sets, the request fails, and Route 53\n\t\t\treturns a HostedZoneNotEmpty error. For information about deleting records\n\t\t\tfrom your hosted zone, see ChangeResourceRecordSets.
To verify that the hosted zone has been deleted, do one of the following:
\nUse the GetHostedZone action to request information about the\n\t\t\t\t\thosted zone.
Use the ListHostedZones action to get a list of the hosted zones\n\t\t\t\t\tassociated with the current Amazon Web Services account.
The ID of the hosted zone you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete a hosted zone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "A complex type that contains the ID, the status, and the date and time of a request to\n\t\t\tdelete a hosted zone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response to a DeleteHostedZone\n\t\t\trequest.
Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it.\n\t\t\tThe KSK must be deactivated before you can delete it regardless of whether the hosted\n\t\t\tzone is enabled for DNSSEC signing.
\nYou can use DeactivateKeySigningKey to deactivate the key before you delete it.
\nUse GetDNSSEC to verify that the KSK is in an INACTIVE\n\t\t\tstatus.
A unique string used to identify a hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "A string used to identify a key-signing key (KSK).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteKeySigningKeyResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteQueryLoggingConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchQueryLoggingConfig" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a configuration for DNS query logging. If you delete a configuration, Amazon\n\t\t\tRoute 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs\n\t\t\tthat are already in CloudWatch Logs.
\nFor more information about DNS query logs, see CreateQueryLoggingConfig.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/queryloggingconfig/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "The ID of the configuration that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteQueryLoggingConfigResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetInUse" + }, + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a reusable delegation set.
\nYou can delete a reusable delegation set only if it isn't associated with any\n\t\t\t\thosted zones.
\nTo verify that the reusable delegation set is not associated with any hosted zones,\n\t\t\tsubmit a GetReusableDelegationSet request and specify the ID of the reusable\n\t\t\tdelegation set that you want to delete.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/2013-04-01/delegationset/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSetRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the reusable delegation set that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete a reusable delegation set.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteReusableDelegationSetResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "An empty element.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteTrafficPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#TrafficPolicyInUse" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a traffic policy.
\nWhen you delete a traffic policy, Route 53 sets a flag on the policy to indicate that\n\t\t\tit has been deleted. However, Route 53 never fully deletes the traffic policy. Note the\n\t\t\tfollowing:
\nDeleted traffic policies aren't listed if you run ListTrafficPolicies.
\nThere's no way to get a list of deleted policies.
\nIf you retain the ID of the policy, you can get information about the policy,\n\t\t\t\t\tincluding the traffic policy document, by running GetTrafficPolicy.
\nDeletes a traffic policy instance and all of the resource record sets that Amazon\n\t\t\tRoute 53 created when you created the instance.
\nIn the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nThe ID of the traffic policy instance that you want to delete.
\nWhen you delete a traffic policy instance, Amazon Route 53 also deletes all of the\n\t\t\t\tresource record sets that were created when you created the traffic policy\n\t\t\t\tinstance.
\nA request to delete a specified traffic policy instance.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyInstanceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "An empty element.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "The ID of the traffic policy that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version number of the traffic policy that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to delete a specified traffic policy version.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteTrafficPolicyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "An empty element.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorization": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationRequest" + }, + "output": { + "target": "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#VPCAssociationAuthorizationNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Removes authorization to submit an AssociateVPCWithHostedZone request to\n\t\t\tassociate a specified VPC with a hosted zone that was created by a different account.\n\t\t\tYou must use the account that created the hosted zone to submit a\n\t\t\t\tDeleteVPCAssociationAuthorization request.
Sending this request only prevents the Amazon Web Services account that created the\n\t\t\t\tVPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If\n\t\t\t\tthe VPC is already associated with the hosted zone,\n\t\t\t\t\tDeleteVPCAssociationAuthorization won't disassociate the VPC from\n\t\t\t\tthe hosted zone. If you want to delete an existing association, use\n\t\t\t\t\tDisassociateVPCFromHostedZone.
When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the\n\t\t\tVPC.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the request to remove authorization to\n\t\t\tassociate a VPC that was created by one Amazon Web Services account with a hosted zone\n\t\t\tthat was created with a different Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DeleteVPCAssociationAuthorizationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Empty response for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#Dimension": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#DimensionField", + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the name of one\n\t\t\tdimension.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.route53#DimensionField", + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, the value of one\n\t\t\tdimension.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "For the metric that the CloudWatch alarm is associated with, a complex type that\n\t\t\tcontains information about one dimension.
" + } + }, + "com.amazonaws.route53#DimensionField": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#DimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Dimension", + "traits": { + "smithy.api#xmlName": "Dimension" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#DisableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyInParentDSRecord" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any\n\t\t\tkey-signing keys (KSKs) that are active in the hosted zone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/disable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "A unique string used to identify a hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DisableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#Disabled": { + "type": "boolean" + }, + "com.amazonaws.route53#DisassociateVPCComment": { + "type": "string" + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZone": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneRequest" + }, + "output": { + "target": "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidVPCId" + }, + { + "target": "com.amazonaws.route53#LastVPCAssociation" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#VPCAssociationNotFound" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53\n\t\t\tprivate hosted zone. Note the following:
\nYou can't disassociate the last Amazon VPC from a private hosted zone.
\nYou can't convert a private hosted zone into a public hosted zone.
\nYou can submit a DisassociateVPCFromHostedZone request using\n\t\t\t\t\teither the account that created the hosted zone or the account that created the\n\t\t\t\t\tAmazon VPC.
Some services, such as Cloud Map and Amazon Elastic File System\n\t\t\t\t\t(Amazon EFS) automatically create hosted zones and associate VPCs with the\n\t\t\t\t\thosted zones. A service can create a hosted zone using your account or using its\n\t\t\t\t\town account. You can disassociate a VPC from a hosted zone only if the service\n\t\t\t\t\tcreated the hosted zone using your account.
\nWhen you run DisassociateVPCFromHostedZone, if the hosted zone has a value for\n\t\t\t\t\t\tOwningAccount, you can use\n\t\t\t\t\t\tDisassociateVPCFromHostedZone. If the hosted zone has a value\n\t\t\t\t\tfor OwningService, you can't use\n\t\t\t\t\t\tDisassociateVPCFromHostedZone.
When revoking access, the hosted zone and the Amazon VPC must belong to\n\t\t\t\tthe same partition. A partition is a group of Amazon Web Services Regions. Each\n\t\t\t\t\tAmazon Web Services account is scoped to one partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe ID of the private hosted zone that you want to disassociate a VPC from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPC": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the VPC that you're disassociating from\n\t\t\tthe specified hosted zone.
", + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#DisassociateVPCComment", + "traits": { + "smithy.api#documentation": "\n Optional: A comment about the disassociation request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the VPC that you want to disassociate\n\t\t\tfrom a specified private hosted zone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#DisassociateVPCFromHostedZoneResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "A complex type that describes the changes made to the specified private hosted\n\t\t\tzone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the disassociate\n\t\t\trequest.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSEC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECRequest" + }, + "output": { + "target": "com.amazonaws.route53#EnableHostedZoneDNSSECResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConcurrentModification" + }, + { + "target": "com.amazonaws.route53#DNSSECNotFound" + }, + { + "target": "com.amazonaws.route53#HostedZonePartiallyDelegated" + }, + { + "target": "com.amazonaws.route53#InvalidArgument" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidKeySigningKeyStatus" + }, + { + "target": "com.amazonaws.route53#InvalidKMSArn" + }, + { + "target": "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "Enables DNSSEC signing in a specific hosted zone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/enable-dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "A unique string used to identify a hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#EnableHostedZoneDNSSECResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#EnableSNI": { + "type": "boolean" + }, + "com.amazonaws.route53#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.route53#ErrorMessages": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#xmlName": "Message" + } + } + }, + "com.amazonaws.route53#EvaluationPeriods": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#FailureThreshold": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#FullyQualifiedDomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#GeoLocation": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "The two-letter code for the continent.
\nAmazon Route 53 supports the following continent codes:
\n\n AF: Africa
\n\n AN: Antarctica
\n\n AS: Asia
\n\n EU: Europe
\n\n OC: Oceania
\n\n NA: North America
\n\n SA: South America
\nConstraint: Specifying ContinentCode with either CountryCode\n\t\t\tor SubdivisionCode returns an InvalidInput error.
For geolocation resource record sets, the two-letter code for a country.
\nAmazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
\nRoute 53 also supports the contry code UA forr Ukraine.
" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "For geolocation resource record sets, the two-letter code for a state of the United\n\t\t\tStates. Route 53 doesn't support any other values for SubdivisionCode. For\n\t\t\ta list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United\n\t\t\tStates Postal Service website.
If you specify subdivisioncode, you must also specify US for\n\t\t\t\tCountryCode.
A complex type that contains information about a geographic location.
" + } + }, + "com.amazonaws.route53#GeoLocationContinentCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.route53#GeoLocationContinentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.route53#GeoLocationCountryCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.route53#GeoLocationCountryName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#GeoLocationDetails": { + "type": "structure", + "members": { + "ContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "The two-letter code for the continent.
" + } + }, + "ContinentName": { + "target": "com.amazonaws.route53#GeoLocationContinentName", + "traits": { + "smithy.api#documentation": "The full name of the continent.
" + } + }, + "CountryCode": { + "target": "com.amazonaws.route53#GeoLocationCountryCode", + "traits": { + "smithy.api#documentation": "The two-letter code for the country.
" + } + }, + "CountryName": { + "target": "com.amazonaws.route53#GeoLocationCountryName", + "traits": { + "smithy.api#documentation": "The name of the country.
" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.
" + } + }, + "SubdivisionName": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionName", + "traits": { + "smithy.api#documentation": "The full name of the subdivision. Route 53 currently supports only states in the\n\t\t\tUnited States.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.
Gets the specified limit for the current account, for example, the maximum number of\n\t\t\thealth checks that you can create using the account.
\nFor the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.
\nYou can also view account limits in Amazon Web Services Trusted Advisor. Sign in to\n\t\t\t\tthe Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.
\nThe limit that you want to get. Valid values include the following:
\n\n MAX_HEALTH_CHECKS_BY_OWNER: The maximum\n\t\t\t\t\tnumber of health checks that you can create using the current account.
\n\n MAX_HOSTED_ZONES_BY_OWNER: The maximum number\n\t\t\t\t\tof hosted zones that you can create using the current account.
\n\n MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The\n\t\t\t\t\tmaximum number of reusable delegation sets that you can create using the current\n\t\t\t\t\taccount.
\n\n MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum\n\t\t\t\t\tnumber of traffic policies that you can create using the current account.
\n\n MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The\n\t\t\t\t\tmaximum number of traffic policy instances that you can create using the current\n\t\t\t\t\taccount. (Traffic policy instances are referred to as traffic flow policy\n\t\t\t\t\trecords in the Amazon Route 53 console.)
\nA complex type that contains information about the request to create a hosted\n\t\t\tzone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetAccountLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#AccountLimit", + "traits": { + "smithy.api#documentation": "The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the\n\t\t\trequest, the value of Limit is the maximum number of health checks that you\n\t\t\tcan create using the current account.
The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of health checks that you have created using the current account.
A complex type that contains the requested limit.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetChange": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetChangeRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetChangeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchChange" + } + ], + "traits": { + "smithy.api#documentation": "Returns the current status of a change batch request. The status is one of the\n\t\t\tfollowing values:
\n\n PENDING indicates that the changes in this request have not\n\t\t\t\t\tpropagated to all Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all\n\t\t\t\t\tchange batch requests.
\n INSYNC indicates that the changes have propagated to all Route 53\n\t\t\t\t\tDNS servers managing the hosted zone.
The ID of the change batch request. The value that you specify here is the value that\n\t\t\t\tChangeResourceRecordSets returned in the Id element when\n\t\t\tyou submitted the request.
The input for a GetChange request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetChangeResponse": { + "type": "structure", + "members": { + "ChangeInfo": { + "target": "com.amazonaws.route53#ChangeInfo", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the specified change batch.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the ChangeInfo element.
Route 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.
\n\n GetCheckerIpRanges still works, but we recommend that you download\n\t\t\t\tip-ranges.json, which includes IP address ranges for all Amazon Web Services\n\t\t\t\tservices. For more information, see IP Address Ranges\n\t\t\t\t\tof Amazon Route 53 Servers in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.
Empty request.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetCheckerIpRangesResponse": { + "type": "structure", + "members": { + "CheckerIpRanges": { + "target": "com.amazonaws.route53#CheckerIpRanges", + "traits": { + "smithy.api#documentation": "A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route\n\t\t\t53 health checkers.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the CheckerIpRanges element.
Returns information about DNSSEC for a specific hosted zone, including the key-signing\n\t\t\tkeys (KSKs) in the hosted zone.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{HostedZoneId}/dnssec", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetDNSSECRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "A unique string used to identify a hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetDNSSECResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.route53#DNSSECStatus", + "traits": { + "smithy.api#documentation": "A string repesenting the status of DNSSEC.
", + "smithy.api#required": {} + } + }, + "KeySigningKeys": { + "target": "com.amazonaws.route53#KeySigningKeys", + "traits": { + "smithy.api#documentation": "The key-signing keys (KSKs) in your account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetGeoLocation": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetGeoLocationRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetGeoLocationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchGeoLocation" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about whether a specified geographic location is supported for Amazon\n\t\t\tRoute 53 geolocation resource record sets.
\nRoute 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.
\nUse the following syntax to determine whether a continent is supported for\n\t\t\tgeolocation:
\n\n GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for\n\t\t\t\t\ta continent\n \n
Use the following syntax to determine whether a country is supported for\n\t\t\tgeolocation:
\n\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode\n \n
Use the following syntax to determine whether a subdivision of a country is supported\n\t\t\tfor geolocation:
\n\n GET /2013-04-01/geolocation?countrycode=two-character country\n\t\t\t\t\tcode&subdivisioncode=subdivision\n\t\t\tcode\n \n
For geolocation resource record sets, a two-letter abbreviation that identifies a\n\t\t\tcontinent. Amazon Route 53 supports the following continent codes:
\n\n AF: Africa
\n\n AN: Antarctica
\n\n AS: Asia
\n\n EU: Europe
\n\n OC: Oceania
\n\n NA: North America
\n\n SA: South America
\nAmazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1\n\t\t\t\talpha-2.
\nRoute 53 also supports the contry code UA forr Ukraine.
", + "smithy.api#httpQuery": "countrycode" + } + }, + "SubdivisionCode": { + "target": "com.amazonaws.route53#GeoLocationSubdivisionCode", + "traits": { + "smithy.api#documentation": "The code for the subdivision, such as a particular state within the United States. For\n\t\t\ta list of US state abbreviations, see Appendix B: Two–Letter State and\n\t\t\t\tPossession Abbreviations on the United States Postal Service website. For a\n\t\t\tlist of all supported subdivision codes, use the ListGeoLocations\n\t\t\tAPI.
", + "smithy.api#httpQuery": "subdivisioncode" + } + } + }, + "traits": { + "smithy.api#documentation": "A request for information about whether a specified geographic location is supported\n\t\t\tfor Amazon Route 53 geolocation resource record sets.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetGeoLocationResponse": { + "type": "structure", + "members": { + "GeoLocationDetails": { + "target": "com.amazonaws.route53#GeoLocationDetails", + "traits": { + "smithy.api#documentation": "A complex type that contains the codes and full continent, country, and subdivision\n\t\t\tnames for the specified geolocation code.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the specified geolocation\n\t\t\tcode.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#IncompatibleVersion" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about a specified health check.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHealthCheckCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHealthCheckCountResponse" + }, + "traits": { + "smithy.api#documentation": "Retrieves the number of health checks that are associated with the current Amazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheckcount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "A request for the number of health checks that are associated with the current Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckCountResponse": { + "type": "structure", + "members": { + "HealthCheckCount": { + "target": "com.amazonaws.route53#HealthCheckCount", + "traits": { + "smithy.api#documentation": "The number of health checks associated with the current Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response to a GetHealthCheckCount\n\t\t\trequest.
Gets the reason that a specified health check failed most recently.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReasonRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "The ID for the health check for which you want the last failure reason. When you\n\t\t\tcreated the health check, CreateHealthCheck returned the ID in the\n\t\t\tresponse, in the HealthCheckId element.
If you want to get the last failure reason for a calculated health check, you must\n\t\t\t\tuse the Amazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckLastFailureReason for a calculated health\n\t\t\t\tcheck.
A request for the reason that a health check failed most recently.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckLastFailureReasonResponse": { + "type": "structure", + "members": { + "HealthCheckObservations": { + "target": "com.amazonaws.route53#HealthCheckObservations", + "traits": { + "smithy.api#documentation": "A list that contains one Observation element for each Amazon Route 53\n\t\t\thealth checker that is reporting a last failure reason.
A complex type that contains the response to a\n\t\t\t\tGetHealthCheckLastFailureReason request.
The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to get information about a specified health check.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.
Gets status of a specified health check.
\nThis API is intended for use during development to diagnose behavior. It doesn’t\n\t\t\t\tsupport production use-cases with high query rates that require immediate and\n\t\t\t\tactionable responses.
\nThe ID for the health check that you want the current status for. When you created the\n\t\t\thealth check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.
If you want to check the status of a calculated health check, you must use the\n\t\t\t\tAmazon Route 53 console or the CloudWatch console. You can't use\n\t\t\t\t\tGetHealthCheckStatus to get the status of a calculated health\n\t\t\t\tcheck.
A request to get the status for a health check.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHealthCheckStatusResponse": { + "type": "structure", + "members": { + "HealthCheckObservations": { + "target": "com.amazonaws.route53#HealthCheckObservations", + "traits": { + "smithy.api#documentation": "A list that contains one HealthCheckObservation element for each Amazon\n\t\t\tRoute 53 health checker that is reporting a status about the health check\n\t\t\tendpoint.
A complex type that contains the response to a GetHealthCheck\n\t\t\trequest.
Gets information about a specified hosted zone including the four name servers\n\t\t\tassigned to the hosted zone.
", + "smithy.api#examples": [ + { + "title": "To get information about a hosted zone", + "documentation": "The following example gets information about the Z3M3LMPEXAMPLE hosted zone.", + "input": { + "Id": "Z3M3LMPEXAMPLE" + }, + "output": { + "HostedZone": { + "ResourceRecordSetCount": 8, + "CallerReference": "C741617D-04E4-F8DE-B9D7-0D150FC61C2E", + "Config": { + "PrivateZone": false + }, + "Id": "/hostedzone/Z3M3LMPEXAMPLE", + "Name": "myawsbucket.com." + }, + "DelegationSet": { + "NameServers": [ + "ns-2048.awsdns-64.com", + "ns-2049.awsdns-65.net", + "ns-2050.awsdns-66.org", + "ns-2051.awsdns-67.co.uk" + ] + } + } + } + ], + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneCount": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetHostedZoneCountRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetHostedZoneCountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonecount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "A request to retrieve a count of all the hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHostedZoneCountResponse": { + "type": "structure", + "members": { + "HostedZoneCount": { + "target": "com.amazonaws.route53#HostedZoneCount", + "traits": { + "smithy.api#documentation": "The total number of public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response to a GetHostedZoneCount\n\t\t\trequest.
Gets the specified limit for a specified hosted zone, for example, the maximum number\n\t\t\tof records that you can create in the hosted zone.
\nFor the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/hostedzonelimit/{HostedZoneId}/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetHostedZoneLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#HostedZoneLimitType", + "traits": { + "smithy.api#documentation": "The limit that you want to get. Valid values include the following:
\n\n MAX_RRSETS_BY_ZONE: The maximum number of\n\t\t\t\t\trecords that you can create in the specified hosted zone.
\n\n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum\n\t\t\t\t\tnumber of Amazon VPCs that you can associate with the specified private hosted\n\t\t\t\t\tzone.
\nThe ID of the hosted zone that you want to get a limit for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the request to create a hosted\n\t\t\tzone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHostedZoneLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#HostedZoneLimit", + "traits": { + "smithy.api#documentation": "The current setting for the specified limit. For example, if you specified\n\t\t\t\tMAX_RRSETS_BY_ZONE for the value of Type in the request,\n\t\t\tthe value of Limit is the maximum number of records that you can create in\n\t\t\tthe specified hosted zone.
The current number of entities that you have created of the specified type. For\n\t\t\texample, if you specified MAX_RRSETS_BY_ZONE for the value of\n\t\t\t\tType in the request, the value of Count is the current\n\t\t\tnumber of records that you have created in the specified hosted zone.
A complex type that contains the requested limit.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetHostedZoneRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the hosted zone that you want to get information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to get information about a specified hosted zone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetHostedZoneResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "A complex type that contains general information about the specified hosted\n\t\t\tzone.
", + "smithy.api#required": {} + } + }, + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "A complex type that lists the Amazon Route 53 name servers for the specified hosted\n\t\t\tzone.
" + } + }, + "VPCs": { + "target": "com.amazonaws.route53#VPCs", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the VPCs that are associated with the\n\t\t\tspecified hosted zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contain the response to a GetHostedZone\n\t\t\trequest.
Gets information about a specified configuration for DNS query logging.
\nFor more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS\n\t\t\tQueries.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/queryloggingconfig/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetQueryLoggingConfigRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "The ID of the configuration for DNS query logging that you want to get information\n\t\t\tabout.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetQueryLoggingConfigResponse": { + "type": "structure", + "members": { + "QueryLoggingConfig": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the query logging configuration that\n\t\t\tyou specified in a GetQueryLoggingConfig request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetReusableDelegationSetRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetReusableDelegationSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#DelegationSetNotReusable" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specified reusable delegation set, including the four\n\t\t\tname servers that are assigned to the delegation set.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/delegationset/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimit": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimitRequest" + }, + "output": { + "target": "com.amazonaws.route53#GetReusableDelegationSetLimitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchDelegationSet" + } + ], + "traits": { + "smithy.api#documentation": "Gets the maximum number of hosted zones that you can associate with the specified\n\t\t\treusable delegation set.
\nFor the default limit, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide. To request a higher limit,\n\t\t\t\topen a case.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/reusabledelegationsetlimit/{DelegationSetId}/{Type}", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimitRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", + "traits": { + "smithy.api#documentation": "Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of\n\t\t\thosted zones that you can associate with the specified reusable delegation set.
The ID of the delegation set that you want to get the limit for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the request to create a hosted\n\t\t\tzone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSetLimitResponse": { + "type": "structure", + "members": { + "Limit": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimit", + "traits": { + "smithy.api#documentation": "The current setting for the limit on hosted zones that you can associate with the\n\t\t\tspecified reusable delegation set.
", + "smithy.api#required": {} + } + }, + "Count": { + "target": "com.amazonaws.route53#UsageCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The current number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the requested limit.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSetRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the reusable delegation set that you want to get a list of name servers\n\t\t\tfor.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A request to get information about a specified reusable delegation set.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetReusableDelegationSetResponse": { + "type": "structure", + "members": { + "DelegationSet": { + "target": "com.amazonaws.route53#DelegationSet", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the reusable delegation set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response to the GetReusableDelegationSet\n\t\t\trequest.
Gets information about a specific traffic policy version.
\nFor information about how of deleting a traffic policy affects the response from\n\t\t\t\tGetTrafficPolicy, see DeleteTrafficPolicy.
Gets information about a specified traffic policy instance.
\n\n\t\t\t\tUse GetTrafficPolicyInstance with the id of new traffic policy instance to confirm that the \n\t\t\t\tCreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request completed successfully. \n\t\t\t\tFor more information, see the State response\n\t\t\t\telement.
In the Route 53 console, traffic policy instances are known as policy\n\t\t\t\trecords.
\nGets the number of traffic policy instances that are associated with the current\n\t\t\t\tAmazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/trafficpolicyinstancecount", + "code": 200 + } + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCountRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Request to get the number of traffic policy instances that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceCountResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstanceCount": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceCount", + "traits": { + "smithy.api#documentation": "The number of traffic policy instances that are associated with the current Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "The ID of the traffic policy instance that you want to get information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gets information about a specified traffic policy instance.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the traffic policy instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "The ID of the traffic policy that you want to get information about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version number of the traffic policy that you want to get information\n\t\t\tabout.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Gets information about a specific traffic policy version.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#GetTrafficPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the specified traffic policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#HealthCheck": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "The identifier that Amazon Route 53 assigned to the health check when you created it.\n\t\t\tWhen you add or update a resource record set, you use this value to specify which health\n\t\t\tcheck to use. The value can be up to 64 characters long.
", + "smithy.api#required": {} + } + }, + "CallerReference": { + "target": "com.amazonaws.route53#HealthCheckNonce", + "traits": { + "smithy.api#documentation": "A unique string that you specified when you created the health check.
", + "smithy.api#required": {} + } + }, + "LinkedService": { + "target": "com.amazonaws.route53#LinkedService", + "traits": { + "smithy.api#documentation": "If the health check was created by another service, the service that created the\n\t\t\thealth check. When a health check is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.
" + } + }, + "HealthCheckConfig": { + "target": "com.amazonaws.route53#HealthCheckConfig", + "traits": { + "smithy.api#documentation": "A complex type that contains detailed information about one health check.
", + "smithy.api#required": {} + } + }, + "HealthCheckVersion": { + "target": "com.amazonaws.route53#HealthCheckVersion", + "traits": { + "smithy.api#documentation": "The version of the health check. You can optionally pass this value in a call to\n\t\t\t\tUpdateHealthCheck to prevent overwriting another change to the health\n\t\t\tcheck.
A complex type that contains information about the CloudWatch alarm that Amazon Route\n\t\t\t53 is monitoring for this health check.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about one health check that is associated\n\t\t\twith the current Amazon Web Services account.
" + } + }, + "com.amazonaws.route53#HealthCheckAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The health check you're attempting to create already exists. Amazon Route 53 returns\n\t\t\tthis error when you submit a request that has the following values:
\nThe same value for CallerReference as an existing health check,\n\t\t\t\t\tand one or more values that differ from the existing health check that has the\n\t\t\t\t\tsame caller reference.
The same value for CallerReference as a health check that you\n\t\t\t\t\tcreated and later deleted, regardless of the other settings in the\n\t\t\t\t\trequest.
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address returned by DNS, Route 53 then\n\t\t\tchecks the health of the endpoint.
Use one of the following formats for the value of IPAddress:
\n IPv4 address: four values between 0 and 255,\n\t\t\t\t\tseparated by periods (.), for example, 192.0.2.44.
\n IPv6 address: eight groups of four\n\t\t\t\t\thexadecimal values, separated by colons (:), for example,\n\t\t\t\t\t\t2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten\n\t\t\t\t\tIPv6 addresses as described in RFC 5952, for example,\n\t\t\t\t\t\t2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance will never\n\t\t\tchange.
For more information, see FullyQualifiedDomainName.
\nConstraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:
\n\n RFC 6598, IANA-Reserved IPv4\n\t\t\t\t\t\tPrefix for Shared Address Space\n
\nWhen the value of Type is CALCULATED or\n\t\t\t\tCLOUDWATCH_METRIC, omit IPAddress.
The port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.
\nDon't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.
The type of health check that you want to create, which indicates how Amazon Route 53\n\t\t\tdetermines whether an endpoint is healthy.
\nYou can't change the value of Type after you create a health\n\t\t\t\tcheck.
You can create the following types of health checks:
\n\n HTTP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTP request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\n\n HTTPS: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection. If successful, Route 53 submits an HTTPS request and waits for an\n\t\t\t\t\tHTTP status code of 200 or greater and less than 400.
\nIf you specify HTTPS for the value of Type, the\n\t\t\t\t\t\tendpoint must support TLS v1.0 or later.
\n HTTP_STR_MATCH: Route 53 tries to establish a\n\t\t\t\t\tTCP connection. If successful, Route 53 submits an HTTP request and searches the\n\t\t\t\t\tfirst 5,120 bytes of the response body for the string that you specify in\n\t\t\t\t\t\tSearchString.
\n HTTPS_STR_MATCH: Route 53 tries to establish\n\t\t\t\t\ta TCP connection. If successful, Route 53 submits an HTTPS request\n\t\t\t\t\tand searches the first 5,120 bytes of the response body for the string that you\n\t\t\t\t\tspecify in SearchString.
\n TCP: Route 53 tries to establish a TCP\n\t\t\t\t\tconnection.
\n\n CLOUDWATCH_METRIC: The health check is\n\t\t\t\t\tassociated with a CloudWatch alarm. If the state of the alarm is\n\t\t\t\t\tOK, the health check is considered healthy. If the state is\n\t\t\t\t\t\tALARM, the health check is considered unhealthy. If CloudWatch\n\t\t\t\t\tdoesn't have sufficient data to determine whether the state is OK\n\t\t\t\t\tor ALARM, the health check status depends on the setting for\n\t\t\t\t\t\tInsufficientDataHealthStatus: Healthy,\n\t\t\t\t\t\tUnhealthy, or LastKnownStatus.
\n CALCULATED: For health checks that monitor\n\t\t\t\t\tthe status of other health checks, Route 53 adds up the number of health checks\n\t\t\t\t\tthat Route 53 health checkers consider to be healthy and compares that number\n\t\t\t\t\twith the value of HealthThreshold.
\n RECOVERY_CONTROL: The health check is\n\t\t\t\t\tassocated with a Route53 Application Recovery Controller routing control. If the\n\t\t\t\t\trouting control state is ON, the health check is considered\n\t\t\t\t\thealthy. If the state is OFF, the health check is considered\n\t\t\t\t\tunhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
", + "smithy.api#required": {} + } + }, + "ResourcePath": { + "target": "com.amazonaws.route53#ResourcePath", + "traits": { + "smithy.api#documentation": "The path, if any, that you want Amazon Route 53 to request when performing health\n\t\t\tchecks. The path can be any value for which your endpoint will return an HTTP status\n\t\t\tcode of 2xx or 3xx when the endpoint is healthy, for example, the file\n\t\t\t/docs/route53-health-check.html. You can also include query string parameters, for\n\t\t\texample, /welcome.html?language=jp&login=y.
Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.
\n If you specify a value for\n IPAddress:
Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and\n\t\t\tpasses the value of FullyQualifiedDomainName in the Host\n\t\t\theader for all health checks except TCP health checks. This is typically the fully\n\t\t\tqualified DNS name of the endpoint on which you want Route 53 to perform health\n\t\t\tchecks.
When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:
If you specify a value of 80 for Port and\n\t\t\t\t\t\tHTTP or HTTP_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify a value of 443 for Port and\n\t\t\t\t\t\tHTTPS or HTTPS_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify another value for Port and any value except\n\t\t\t\t\t\tTCP for Type, Route 53 passes\n\t\t\t\t\t\tFullyQualifiedDomainName:Port to the endpoint in the\n\t\t\t\t\t\tHost header.
If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the preceding cases.
\n If you don't specify a value for\n IPAddress:
Route 53 sends a DNS request to the domain that you specify for\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify for\n\t\t\t\tRequestInterval. Using an IPv4 address that DNS returns, Route 53 then\n\t\t\tchecks the health of the endpoint.
If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.
If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record sets\n\t\t\t(www.example.com).
In this configuration, if you create a health check for which the value of\n\t\t\t\t\tFullyQualifiedDomainName matches the name of the resource record\n\t\t\t\tsets and you then associate the health check with those resource record sets, health\n\t\t\t\tcheck results will be unpredictable.
In addition, if the value that you specify for Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.
If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH,\n\t\t\tthe string that you want Amazon Route 53 to search for in the response body from the\n\t\t\tspecified resource. If the string appears in the response body, Route 53 considers the\n\t\t\tresource healthy.
Route 53 considers case when searching for SearchString in the response\n\t\t\tbody.
The number of seconds between the time that Amazon Route 53 gets a response from your\n\t\t\tendpoint and the time that it sends the next health check request. Each Route 53 health\n\t\t\tchecker makes requests at this interval.
\nYou can't change the value of RequestInterval after you create a\n\t\t\t\thealth check.
If you don't specify a value for RequestInterval, the default value is\n\t\t\t\t30 seconds.
The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.
Specify whether you want Amazon Route 53 to measure the latency between health\n\t\t\tcheckers in multiple Amazon Web Services regions and your endpoint, and to display\n\t\t\tCloudWatch latency graphs on the Health Checks page in\n\t\t\tthe Route 53 console.
\nYou can't change the value of MeasureLatency after you create a\n\t\t\t\thealth check.
Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.
" + } + }, + "Disabled": { + "target": "com.amazonaws.route53#Disabled", + "traits": { + "smithy.api#documentation": "Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:
\n\n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.
\n\n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.
\n\n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.
\nAfter you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.
\nCharges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.
" + } + }, + "HealthThreshold": { + "target": "com.amazonaws.route53#HealthThreshold", + "traits": { + "smithy.api#documentation": "The number of child health checks that are associated with a CALCULATED\n\t\t\thealth check that Amazon Route 53 must consider healthy for the CALCULATED\n\t\t\thealth check to be considered healthy. To specify the child health checks that you want\n\t\t\tto associate with a CALCULATED health check, use the ChildHealthChecks element.
Note the following:
\nIf you specify a number greater than the number of child health checks, Route\n\t\t\t\t\t53 always considers this health check to be unhealthy.
\nIf you specify 0, Route 53 always considers this health check to\n\t\t\t\t\tbe healthy.
(CALCULATED Health Checks Only) A complex type that contains one\n\t\t\t\tChildHealthCheck element for each health check that you want to\n\t\t\tassociate with a CALCULATED health check.
Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows the endpoint\n\t\t\tto respond to HTTPS health check requests with the applicable SSL/TLS\n\t\t\tcertificate.
Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.
A complex type that contains one Region element for each region from\n\t\t\twhich you want Amazon Route 53 health checkers to check the specified endpoint.
If you don't specify any regions, Route 53 health checkers automatically performs\n\t\t\tchecks from all of the regions that are listed under Valid\n\t\t\t\tValues.
\nIf you update a health check to remove a region that has been performing health\n\t\t\tchecks, Route 53 will briefly continue to perform checks from that region to ensure that\n\t\t\tsome health checkers are always checking the endpoint (for example, if you replace three\n\t\t\tregions with four different regions).
" + } + }, + "AlarmIdentifier": { + "target": "com.amazonaws.route53#AlarmIdentifier", + "traits": { + "smithy.api#documentation": "A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.
" + } + }, + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "traits": { + "smithy.api#documentation": "When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:
\n\n Healthy: Route 53 considers the health check to be\n\t\t\t\t\thealthy.
\n Unhealthy: Route 53 considers the health check to be\n\t\t\t\t\tunhealthy.
\n LastKnownStatus: Route 53 uses the status of the health check\n\t\t\t\t\tfrom the last time that CloudWatch had sufficient data to determine the alarm\n\t\t\t\t\tstate. For new health checks that have no last known status, the default status\n\t\t\t\t\tfor the health check is healthy.
The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller\n\t\t\trouting control.
\nFor more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the health check.
" + } + }, + "com.amazonaws.route53#HealthCheckCount": { + "type": "long" + }, + "com.amazonaws.route53#HealthCheckId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "This error code is not in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#HealthCheckNonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckObservation": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.route53#HealthCheckRegion", + "traits": { + "smithy.api#documentation": "The region of the Amazon Route 53 health checker that provided the status in\n\t\t\t\tStatusReport.
The IP address of the Amazon Route 53 health checker that provided the failure reason\n\t\t\tin StatusReport.
A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker and the time of the failed health check.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the last failure reason as reported by one Amazon Route\n\t\t\t53 health checker.
" + } + }, + "com.amazonaws.route53#HealthCheckObservations": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckObservation", + "traits": { + "smithy.api#xmlName": "HealthCheckObservation" + } + } + }, + "com.amazonaws.route53#HealthCheckRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HealthCheckRegion", + "traits": { + "smithy.api#xmlName": "Region" + } + }, + "traits": { + "smithy.api#length": { + "min": 3, + "max": 64 + } + } + }, + "com.amazonaws.route53#HealthCheckType": { + "type": "enum", + "members": { + "HTTP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP" + } + }, + "HTTPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS" + } + }, + "HTTP_STR_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTP_STR_MATCH" + } + }, + "HTTPS_STR_MATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HTTPS_STR_MATCH" + } + }, + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "CALCULATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CALCULATED" + } + }, + "CLOUDWATCH_METRIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDWATCH_METRIC" + } + }, + "RECOVERY_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOVERY_CONTROL" + } + } + } + }, + "com.amazonaws.route53#HealthCheckVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#HealthCheckVersionMismatch": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The value of HealthCheckVersion in the request doesn't match the value of\n\t\t\t\tHealthCheckVersion in the health check.
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "The name of the domain. For public hosted zones, this is the name that you have\n\t\t\tregistered with your DNS registrar.
\nFor information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see CreateHostedZone.
The value that you specified for CallerReference when you created the\n\t\t\thosted zone.
A complex type that includes the Comment and PrivateZone\n\t\t\telements. If you omitted the HostedZoneConfig and Comment\n\t\t\telements from the request, the Config and Comment elements\n\t\t\tdon't appear in the response.
The number of resource record sets in the hosted zone.
" + } + }, + "LinkedService": { + "target": "com.amazonaws.route53#LinkedService", + "traits": { + "smithy.api#documentation": "If the hosted zone was created by another service, the service that created the hosted\n\t\t\tzone. When a hosted zone is created by another service, you can't edit or delete it\n\t\t\tusing Route 53.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
" + } + }, + "com.amazonaws.route53#HostedZoneAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The hosted zone you're trying to create already exists. Amazon Route 53 returns this\n\t\t\terror when a hosted zone has already been created with the specified\n\t\t\t\tCallerReference.
Any comments that you want to include about the hosted zone.
" + } + }, + "PrivateZone": { + "target": "com.amazonaws.route53#IsPrivateZone", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A value that indicates whether this is a private hosted zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains an optional comment about your hosted zone. If you don't\n\t\t\twant to specify a comment, omit both the HostedZoneConfig and\n\t\t\t\tComment elements.
The limit that you requested. Valid values include the following:
\n\n MAX_RRSETS_BY_ZONE: The maximum number of\n\t\t\t\t\trecords that you can create in the specified hosted zone.
\n\n MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum\n\t\t\t\t\tnumber of Amazon VPCs that you can associate with the specified private hosted\n\t\t\t\t\tzone.
\nThe current value for the limit that is specified by Type.
A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.
" + } + }, + "com.amazonaws.route53#HostedZoneLimitType": { + "type": "enum", + "members": { + "MAX_RRSETS_BY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_RRSETS_BY_ZONE" + } + }, + "MAX_VPCS_ASSOCIATED_BY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_VPCS_ASSOCIATED_BY_ZONE" + } + } + } + }, + "com.amazonaws.route53#HostedZoneNotEmpty": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The hosted zone contains resource records that are not SOA or NS records.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#HostedZoneNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified HostedZone can't be found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneNotPrivate": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified hosted zone is a public hosted zone, not a private hosted zone.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneOwner": { + "type": "structure", + "members": { + "OwningAccount": { + "target": "com.amazonaws.route53#AWSAccountID", + "traits": { + "smithy.api#documentation": "If the hosted zone was created by an Amazon Web Services account, or was created by an\n\t\t\t\tAmazon Web Services service that creates hosted zones using the current account,\n\t\t\t\tOwningAccount contains the account ID of that account. For example,\n\t\t\twhen you use Cloud Map to create a hosted zone, Cloud Map creates the hosted\n\t\t\tzone using the current Amazon Web Services account.
If an Amazon Web Services service uses its own account to create a hosted zone and\n\t\t\tassociate the specified VPC with that hosted zone, OwningService contains\n\t\t\tan abbreviation that identifies the service. For example, if Amazon Elastic File System\n\t\t\t(Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value\n\t\t\tof OwningService is efs.amazonaws.com.
A complex type that identifies a hosted zone that a specified Amazon VPC is associated\n\t\t\twith and the owner of the hosted zone. If there is a value for\n\t\t\t\tOwningAccount, there is no value for OwningService, and\n\t\t\tvice versa.
The hosted zone nameservers don't match the parent nameservers. The hosted zone and\n\t\t\tparent must have the same nameservers.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#HostedZoneRRSetCount": { + "type": "long" + }, + "com.amazonaws.route53#HostedZoneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#HostedZoneSummary", + "traits": { + "smithy.api#xmlName": "HostedZoneSummary" + } + } + }, + "com.amazonaws.route53#HostedZoneSummary": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The Route 53 hosted zone ID of a private hosted zone that the specified VPC is\n\t\t\tassociated with.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "The name of the private hosted zone, such as example.com.
The owner of a private hosted zone that the specified VPC is associated with. The\n\t\t\towner can be either an Amazon Web Services account or an Amazon Web Services\n\t\t\tservice.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "In the response to a ListHostedZonesByVPC request, the\n\t\t\t\tHostedZoneSummaries element contains one HostedZoneSummary\n\t\t\telement for each hosted zone that the specified Amazon VPC is associated with. Each\n\t\t\t\tHostedZoneSummary element contains the hosted zone name and ID, and\n\t\t\tinformation about who owns the hosted zone.
The resource you're trying to access is unsupported on this Amazon Route 53\n\t\t\tendpoint.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InsufficientCloudWatchLogsResourcePolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Amazon Route 53 doesn't have the permissions required to create log streams and send\n\t\t\tquery logs to log streams. Possible causes include the following:
\nThere is no resource policy that specifies the log group ARN in the value for\n\t\t\t\t\t\tResource.
The resource policy that includes the log group ARN in the value for\n\t\t\t\t\t\tResource doesn't have the necessary permissions.
The resource policy hasn't finished propagating yet.
\nThe Key management service (KMS) key you specified doesn’t exist or it can’t\n\t\t\t\t\tbe used with the log group associated with query log. Update or provide a\n\t\t\t\t\tresource policy to grant permissions for the KMS key.
\nThe Key management service (KMS) key you specified is marked as \n\t\t\t\tdisabled for the log group associated with query log. Update or provide \n\t\t\t\ta resource policy to grant permissions for the KMS key.
\nParameter name is not valid.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidChangeBatch": { + "type": "structure", + "members": { + "messages": { + "target": "com.amazonaws.route53#ErrorMessages", + "traits": { + "smithy.api#documentation": "" + } + }, + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "This exception contains a list of messages that might contain one or more error\n\t\t\tmessages. Each error message indicates one error in the change batch.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidDomainName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified domain name is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidInput": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The input is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidKMSArn": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC\n\t\t\tsigning.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyName": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The key-signing key (KSK) name that you specified isn't a valid name.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidKeySigningKeyStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The key-signing key (KSK) status isn't valid or another KSK has the status\n\t\t\t\tINTERNAL_FAILURE.
The value that you specified to get the second or subsequent page of results is\n\t\t\tinvalid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#InvalidSigningStatus": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "Your hosted zone status isn't valid for this operation. In the hosted zone, change the\n\t\t\tstatus to enable DNSSEC or disable DNSSEC.
The format of the traffic policy document that you specified in the\n\t\t\t\tDocument element is not valid.
The VPC ID that you specified either isn't a valid ID or the current account is not\n\t\t\tauthorized to access this VPC.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#Inverted": { + "type": "boolean" + }, + "com.amazonaws.route53#IsPrivateZone": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#KeySigningKey": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53#SigningKeyName", + "traits": { + "smithy.api#documentation": "A string used to identify a key-signing key (KSK). Name can include\n\t\t\tnumbers, letters, and underscores (_). Name must be unique for each\n\t\t\tkey-signing key in the same hosted zone.
The Amazon resource name (ARN) used to identify the customer managed key in Key Management Service (KMS). The KmsArn must be unique for each\n\t\t\tkey-signing key (KSK) in a single hosted zone.
You must configure the customer managed key as follows:
\nEnabled
\nECC_NIST_P256
\nSign and verify
\nThe key policy must give permission for the following actions:
\nDescribeKey
\nGetPublicKey
\nSign
\nThe key policy must also include the Amazon Route 53 service in the\n\t\t\t\t\t\tprincipal for your account. Specify the following:
\n\n \"Service\": \"dnssec-route53.amazonaws.com\"\n
For more information about working with the customer managed key in KMS, see Key Management Service\n\t\t\t\tconcepts.
" + } + }, + "Flag": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "An integer that specifies how the key is used. For key-signing key (KSK), this value\n\t\t\tis always 257.
" + } + }, + "SigningAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "A string used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.
" + } + }, + "SigningAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "An integer used to represent the signing algorithm. This value must follow the\n\t\t\tguidelines provided by RFC-8624 Section 3.1.
" + } + }, + "DigestAlgorithmMnemonic": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "A string used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section 3.3.\n\t\t
" + } + }, + "DigestAlgorithmType": { + "target": "com.amazonaws.route53#SigningKeyInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "An integer used to represent the delegation signer digest algorithm. This value must\n\t\t\tfollow the guidelines provided by RFC-8624 Section\n\t\t\t3.3.
" + } + }, + "KeyTag": { + "target": "com.amazonaws.route53#SigningKeyTag", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "An integer used to identify the DNSSEC record for the domain name. The process used to\n\t\t\tcalculate the value is described in RFC-4034 Appendix B.
" + } + }, + "DigestValue": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to\n\t\t\tpublish the public key that resolvers can use to verify DNSSEC signatures that are used\n\t\t\tto secure certain kinds of information provided by the DNS system.
" + } + }, + "PublicKey": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
" + } + }, + "DSRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "A string that represents a delegation signer (DS) record.
" + } + }, + "DNSKEYRecord": { + "target": "com.amazonaws.route53#SigningKeyString", + "traits": { + "smithy.api#documentation": "A string that represents a DNSKEY record.
" + } + }, + "Status": { + "target": "com.amazonaws.route53#SigningKeyStatus", + "traits": { + "smithy.api#documentation": "A string that represents the current key-signing key (KSK) status.
\nStatus can have one of the following values:
\nThe KSK is being used for signing.
\nThe KSK is not being used for signing.
\nThe KSK is in the process of being deleted.
\nThere is a problem with the KSK that requires you to take action to\n\t\t\t\t\t\tresolve. For example, the customer managed key might have been deleted,\n\t\t\t\t\t\tor the permissions for the customer managed key might have been\n\t\t\t\t\t\tchanged.
\nThere was an error during a request. Before you can continue to work with\n\t\t\t\t\t\tDNSSEC signing, including actions that involve this KSK, you must correct\n\t\t\t\t\t\tthe problem. For example, you may need to activate or deactivate the\n\t\t\t\t\t\tKSK.
\nThe status message provided for the following key-signing key (KSK) statuses:\n\t\t\t\tACTION_NEEDED or INTERNAL_FAILURE. The status message\n\t\t\tincludes information about what the problem might be and steps that you can take to\n\t\t\tcorrect the issue.
The date when the key-signing key (KSK) was created.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "The last time that the key-signing key (KSK) was changed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A key-signing key (KSK) is a complex type that represents a public/private key pair.\n\t\t\tThe private key is used to generate a digital signature for the zone signing key (ZSK).\n\t\t\tThe public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always\n\t\t\tassociated with a hosted zone; it cannot exist by itself.
" + } + }, + "com.amazonaws.route53#KeySigningKeyAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#KeySigningKeyInParentDSRecord": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The key-signing key (KSK) is specified in a parent DS record.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#KeySigningKeyInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The key-signing key (KSK) that you specified can't be deactivated because it's the\n\t\t\tonly KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable\n\t\t\tanother KSK.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#KeySigningKeyWithActiveStatusNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "A key-signing key (KSK) with ACTIVE status wasn't found.
The VPC that you're trying to disassociate from the private hosted zone is the last\n\t\t\tVPC that is associated with the hosted zone. Amazon Route 53 doesn't support\n\t\t\tdisassociating the last VPC from a hosted zone.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#LimitValue": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.route53#LimitsExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "This operation can't be completed because the current account has reached the\n\t\t\tlimit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#LinkedService": { + "type": "structure", + "members": { + "ServicePrincipal": { + "target": "com.amazonaws.route53#ServicePrincipal", + "traits": { + "smithy.api#documentation": "If the health check or hosted zone was created by another service, the service that\n\t\t\tcreated the resource. When a resource is created by another service, you can't edit or\n\t\t\tdelete it using Amazon Route 53.
" + } + }, + "Description": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "If the health check or hosted zone was created by another service, an optional\n\t\t\tdescription that can be provided by the other service. When a resource is created by\n\t\t\tanother service, you can't edit or delete it using Amazon Route 53.
" + } + } + }, + "traits": { + "smithy.api#documentation": "If a health check or hosted zone was created by another service,\n\t\t\t\tLinkedService is a complex type that describes the service that created\n\t\t\tthe resource. When a resource is created by another service, you can't edit or delete it\n\t\t\tusing Amazon Route 53.
Returns a paginated list of location objects and their CIDR blocks.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}/cidrblocks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrBlocks", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrBlocksRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "The UUID of the CIDR collection.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultNotAllowed", + "traits": { + "smithy.api#documentation": "The name of the CIDR collection location.
", + "smithy.api#httpQuery": "location" + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "Maximum number of results you want returned.
", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListCidrBlocksResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
" + } + }, + "CidrBlocks": { + "target": "com.amazonaws.route53#CidrBlockSummaries", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the CIDR blocks.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListCidrCollections": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrCollectionsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrCollectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of CIDR collections in the Amazon Web Services account\n\t\t\t(metadata only).
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrCollections", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrCollectionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of CIDR collections to return in the response.
", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListCidrCollectionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
" + } + }, + "CidrCollections": { + "target": "com.amazonaws.route53#CollectionSummaries", + "traits": { + "smithy.api#documentation": "A complex type with information about the CIDR collection.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListCidrLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListCidrLocationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListCidrLocationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchCidrCollectionException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated list of CIDR locations for the given collection (metadata only,\n\t\t\tdoes not include CIDR blocks).
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/cidrcollection/{CollectionId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "CidrLocations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListCidrLocationsRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.route53#UUID", + "traits": { + "smithy.api#documentation": "The CIDR collection ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
", + "smithy.api#httpQuery": "nexttoken" + } + }, + "MaxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of CIDR collection locations to return in the response.
", + "smithy.api#httpQuery": "maxresults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListCidrLocationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token to indicate where the service is to begin enumerating\n\t\t\tresults.
\nIf no value is provided, the listing of results starts from the beginning.
" + } + }, + "CidrLocations": { + "target": "com.amazonaws.route53#LocationSummaries", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the list of CIDR locations.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListGeoLocations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListGeoLocationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListGeoLocationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of supported geographic locations.
\nCountries are listed first, and continents are listed last. If Amazon Route 53\n\t\t\tsupports subdivisions for a country (for example, states or provinces), the subdivisions\n\t\t\tfor that country are listed in alphabetical order immediately after the corresponding\n\t\t\tcountry.
\nRoute 53 does not perform authorization for this API because it retrieves information\n\t\t\tthat is already available to the public.
\nFor a list of supported geolocation codes, see the GeoLocation data\n\t\t\ttype.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/geolocations", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListGeoLocationsRequest": { + "type": "structure", + "members": { + "StartContinentCode": { + "target": "com.amazonaws.route53#GeoLocationContinentCode", + "traits": { + "smithy.api#documentation": "The code for the continent with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if NextContinentCode from\n\t\t\tthe previous response has a value, enter that value in startcontinentcode\n\t\t\tto return the next page of results.
Include startcontinentcode only if you want to list continents. Don't\n\t\t\tinclude startcontinentcode when you're listing countries or countries with\n\t\t\ttheir subdivisions.
The code for the country with which you want to start listing locations that Amazon\n\t\t\tRoute 53 supports for geolocation. If Route 53 has already returned a page or more of\n\t\t\tresults, if IsTruncated is true, and if\n\t\t\t\tNextCountryCode from the previous response has a value, enter that\n\t\t\tvalue in startcountrycode to return the next page of results.
The code for the state of the United States with which you want to start listing\n\t\t\tlocations that Amazon Route 53 supports for geolocation. If Route 53 has already\n\t\t\treturned a page or more of results, if IsTruncated is true,\n\t\t\tand if NextSubdivisionCode from the previous response has a value, enter\n\t\t\tthat value in startsubdivisioncode to return the next page of\n\t\t\tresults.
To list subdivisions (U.S. states), you must include both\n\t\t\t\tstartcountrycode and startsubdivisioncode.
(Optional) The maximum number of geolocations to be included in the response body for\n\t\t\tthis request. If more than maxitems geolocations remain to be listed, then\n\t\t\tthe value of the IsTruncated element in the response is\n\t\t\ttrue.
A request to get a list of geographic locations that Amazon Route 53 supports for\n\t\t\tgeolocation resource record sets.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListGeoLocationsResponse": { + "type": "structure", + "members": { + "GeoLocationDetailsList": { + "target": "com.amazonaws.route53#GeoLocationDetailsList", + "traits": { + "smithy.api#documentation": "A complex type that contains one GeoLocationDetails element for each\n\t\t\tlocation that Amazon Route 53 supports for geolocation.
A value that indicates whether more locations remain to be listed after the last\n\t\t\tlocation in this response. If so, the value of IsTruncated is\n\t\t\t\ttrue. To get more values, submit another request and include the values\n\t\t\tof NextContinentCode, NextCountryCode, and\n\t\t\t\tNextSubdivisionCode in the startcontinentcode,\n\t\t\t\tstartcountrycode, and startsubdivisioncode, as\n\t\t\tapplicable.
If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextContinentCode in the\n\t\t\t\tstartcontinentcode parameter in another ListGeoLocations\n\t\t\trequest.
If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextCountryCode in the\n\t\t\t\tstartcountrycode parameter in another ListGeoLocations\n\t\t\trequest.
If IsTruncated is true, you can make a follow-up request to\n\t\t\tdisplay more locations. Enter the value of NextSubdivisionCode in the\n\t\t\t\tstartsubdivisioncode parameter in another ListGeoLocations\n\t\t\trequest.
The value that you specified for MaxItems in the request.
A complex type containing the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListHealthChecks": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHealthChecksRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHealthChecksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#IncompatibleVersion" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/healthcheck", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextMarker", + "items": "HealthChecks", + "pageSize": "MaxItems" + } + } + }, + "com.amazonaws.route53#ListHealthChecksRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more health checks. To get another group, submit another\n\t\t\t\tListHealthChecks request.
For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first health check that Amazon Route\n\t\t\t53 will return if you submit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more health checks to get.
The maximum number of health checks that you want ListHealthChecks to\n\t\t\treturn in response to the current request. Amazon Route 53 returns a maximum of 1000\n\t\t\titems. If you set MaxItems to a value greater than 1000, Route 53 returns\n\t\t\tonly the first 1000 health checks.
A request to retrieve a list of the health checks that are associated with the current\n\t\t\t\tAmazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHealthChecksResponse": { + "type": "structure", + "members": { + "HealthChecks": { + "target": "com.amazonaws.route53#HealthChecks", + "traits": { + "smithy.api#documentation": "A complex type that contains one HealthCheck element for each health\n\t\t\tcheck that is associated with the current Amazon Web Services account.
For the second and subsequent calls to ListHealthChecks,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the previous request.
A flag that indicates whether there are more health checks to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of health checks by submitting\n\t\t\tanother ListHealthChecks request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.
If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first health check that Amazon Route 53 returns if you submit another\n\t\t\t\tListHealthChecks request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHealthChecks that produced the current response.
A complex type that contains the response to a ListHealthChecks\n\t\t\trequest.
Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account. The response includes a HostedZones\n\t\t\tchild element for each hosted zone.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of\n\t\t\thosted zones, you can use the maxitems parameter to list them in groups of\n\t\t\tup to 100.
Retrieves a list of your hosted zones in lexicographic order. The response includes a\n\t\t\t\tHostedZones child element for each hosted zone created by the current\n\t\t\t\tAmazon Web Services account.
\n ListHostedZonesByName sorts hosted zones by name with the labels\n\t\t\treversed. For example:
\n com.example.www.\n
Note the trailing dot, which can change the sort order in some circumstances.
\nIf the domain name includes escape characters or Punycode,\n\t\t\t\tListHostedZonesByName alphabetizes the domain name using the escaped or\n\t\t\tPunycoded value, which is the format that Amazon Route 53 saves in its database. For\n\t\t\texample, to create a hosted zone for exämple.com, you specify ex\\344mple.com for\n\t\t\tthe domain name. ListHostedZonesByName alphabetizes it as:
\n com.ex\\344mple.\n
The labels are reversed and alphabetized using the escaped value. For more information\n\t\t\tabout valid domain name formats, including internationalized domain names, see DNS\n\t\t\t\tDomain Name Format in the Amazon Route 53 Developer\n\t\t\t\tGuide.
\nRoute 53 returns up to 100 items in each response. If you have a lot of hosted zones,\n\t\t\tuse the MaxItems parameter to list them in groups of up to 100. The\n\t\t\tresponse includes values that help navigate from one group of MaxItems\n\t\t\thosted zones to the next:
The DNSName and HostedZoneId elements in the\n\t\t\t\t\tresponse contain the values, if any, specified for the dnsname and\n\t\t\t\t\t\thostedzoneid parameters in the request that produced the\n\t\t\t\t\tcurrent response.
The MaxItems element in the response contains the value, if any,\n\t\t\t\t\tthat you specified for the maxitems parameter in the request that\n\t\t\t\t\tproduced the current response.
If the value of IsTruncated in the response is true, there are\n\t\t\t\t\tmore hosted zones associated with the current Amazon Web Services account.
If IsTruncated is false, this response includes the last hosted\n\t\t\t\t\tzone that is associated with the current account. The NextDNSName\n\t\t\t\t\telement and NextHostedZoneId elements are omitted from the\n\t\t\t\t\tresponse.
The NextDNSName and NextHostedZoneId elements in the\n\t\t\t\t\tresponse contain the domain name and the hosted zone ID of the next hosted zone\n\t\t\t\t\tthat is associated with the current Amazon Web Services account. If you want to\n\t\t\t\t\tlist more hosted zones, make another call to ListHostedZonesByName,\n\t\t\t\t\tand specify the value of NextDNSName and\n\t\t\t\t\t\tNextHostedZoneId in the dnsname and\n\t\t\t\t\t\thostedzoneid parameters, respectively.
(Optional) For your first request to ListHostedZonesByName, include the\n\t\t\t\tdnsname parameter only if you want to specify the name of the first\n\t\t\thosted zone in the response. If you don't include the dnsname parameter,\n\t\t\tAmazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both\n\t\t\t\tdnsname and hostedzoneid parameters. For\n\t\t\t\tdnsname, specify the value of NextDNSName from the\n\t\t\tprevious response.
(Optional) For your first request to ListHostedZonesByName, do not\n\t\t\tinclude the hostedzoneid parameter.
If you have more hosted zones than the value of maxitems,\n\t\t\t\tListHostedZonesByName returns only the first maxitems\n\t\t\thosted zones. To get the next group of maxitems hosted zones, submit\n\t\t\tanother request to ListHostedZonesByName and include both\n\t\t\t\tdnsname and hostedzoneid parameters. For the value of\n\t\t\t\thostedzoneid, specify the value of the NextHostedZoneId\n\t\t\telement from the previous response.
The maximum number of hosted zones to be included in the response body for this\n\t\t\trequest. If you have more than maxitems hosted zones, then the value of the\n\t\t\t\tIsTruncated element in the response is true, and the values of\n\t\t\t\tNextDNSName and NextHostedZoneId specify the first hosted\n\t\t\tzone in the next group of maxitems hosted zones.
Retrieves a list of the public and private hosted zones that are associated with the\n\t\t\tcurrent Amazon Web Services account in ASCII order by domain name.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHostedZonesByNameResponse": { + "type": "structure", + "members": { + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", + "traits": { + "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
", + "smithy.api#required": {} + } + }, + "DNSName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "For the second and subsequent calls to ListHostedZonesByName,\n\t\t\t\tDNSName is the value that you specified for the dnsname\n\t\t\tparameter in the request that produced the current response.
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
" + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A flag that indicates whether there are more hosted zones to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of maxitems hosted zones\n\t\t\tby calling ListHostedZonesByName again and specifying the values of\n\t\t\t\tNextDNSName and NextHostedZoneId elements in the\n\t\t\t\tdnsname and hostedzoneid parameters.
If IsTruncated is true, the value of NextDNSName is the name\n\t\t\tof the first hosted zone in the next group of maxitems hosted zones. Call\n\t\t\t\tListHostedZonesByName again and specify the value of\n\t\t\t\tNextDNSName and NextHostedZoneId in the\n\t\t\t\tdnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
If IsTruncated is true, the value of\n\t\t\t\tNextHostedZoneId identifies the first hosted zone in the next group of\n\t\t\t\tmaxitems hosted zones. Call ListHostedZonesByName again\n\t\t\tand specify the value of NextDNSName and NextHostedZoneId in\n\t\t\tthe dnsname and hostedzoneid parameters, respectively.
This element is present only if IsTruncated is true.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZonesByName that produced the current response.
A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListHostedZonesByVPC": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListHostedZonesByVPCRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListHostedZonesByVPCResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account or Amazon Web Services service owns the hosted zones.\n\t\t\tThe HostedZoneOwner structure in the response contains one of the following\n\t\t\tvalues:
An OwningAccount element, which contains the account number of\n\t\t\t\t\teither the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create\n\t\t\t\t\thosted zones using the current account.
An OwningService element, which identifies the Amazon Web Services\n\t\t\t\t\tservice that created and owns the hosted zone. For example, if a hosted zone was\n\t\t\t\t\tcreated by Amazon Elastic File System (Amazon EFS), the value of\n\t\t\t\t\t\tOwner is efs.amazonaws.com.
When listing private hosted zones, the hosted zone and the Amazon VPC must\n\t\t\t\tbelong to the same partition where the hosted zones were created. A partition is a\n\t\t\t\tgroup of Amazon Web Services Regions. Each Amazon Web Services account is scoped to\n\t\t\t\tone partition.
\nThe following are the supported partitions:
\n\n aws - Amazon Web Services Regions
\n aws-cn - China Regions
\n aws-us-gov - Amazon Web Services GovCloud (US) Region
For more information, see Access Management\n\t\t\t\tin the Amazon Web Services General Reference.
\nThe ID of the Amazon VPC that you want to list hosted zones for.
", + "smithy.api#httpQuery": "vpcid", + "smithy.api#required": {} + } + }, + "VPCRegion": { + "target": "com.amazonaws.route53#VPCRegion", + "traits": { + "smithy.api#documentation": "For the Amazon VPC that you specified for VPCId, the Amazon Web Services\n\t\t\tRegion that you created the VPC in.
(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf the specified VPC is associated with more than MaxItems hosted zones,\n\t\t\tthe response includes a NextToken element. NextToken contains\n\t\t\tan encrypted token that identifies the first hosted zone that Route 53 will return if\n\t\t\tyou submit another request.
If the previous response included a NextToken element, the specified VPC\n\t\t\tis associated with more hosted zones. To get more hosted zones, submit another\n\t\t\t\tListHostedZonesByVPC request.
For the value of NextToken, specify the value of NextToken\n\t\t\tfrom the previous response.
If the previous response didn't include a NextToken element, there are no\n\t\t\tmore hosted zones to get.
Lists all the private hosted zones that a specified VPC is associated with, regardless\n\t\t\tof which Amazon Web Services account created the hosted zones.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHostedZonesByVPCResponse": { + "type": "structure", + "members": { + "HostedZoneSummaries": { + "target": "com.amazonaws.route53#HostedZoneSummaries", + "traits": { + "smithy.api#documentation": "A list that contains one HostedZoneSummary element for each hosted zone\n\t\t\tthat the specified Amazon VPC is associated with. Each HostedZoneSummary\n\t\t\telement contains the hosted zone name and ID, and information about who owns the hosted\n\t\t\tzone.
The value that you specified for MaxItems in the most recent\n\t\t\t\tListHostedZonesByVPC request.
The value that you will use for NextToken in the next\n\t\t\t\tListHostedZonesByVPC request.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more hosted zones. To get more hosted zones, submit\n\t\t\tanother ListHostedZones request.
For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first hosted zone that Amazon Route\n\t\t\t53 will return if you submit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more hosted zones to get.
(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return.\n\t\t\tIf you have more than maxitems hosted zones, the value of\n\t\t\t\tIsTruncated in the response is true, and the value of\n\t\t\t\tNextMarker is the hosted zone ID of the first hosted zone that Route 53\n\t\t\twill return if you submit another request.
If you're using reusable delegation sets and you want to list all of the hosted zones\n\t\t\tthat are associated with a reusable delegation set, specify the ID of that reusable\n\t\t\tdelegation set.
", + "smithy.api#httpQuery": "delegationsetid" + } + }, + "HostedZoneType": { + "target": "com.amazonaws.route53#HostedZoneType", + "traits": { + "smithy.api#documentation": "\n\t\t\t(Optional) Specifies if the hosted zone is private.\n\t\t
", + "smithy.api#httpQuery": "hostedzonetype" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to retrieve a list of the public and private hosted zones that are\n\t\t\tassociated with the current Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListHostedZonesResponse": { + "type": "structure", + "members": { + "HostedZones": { + "target": "com.amazonaws.route53#HostedZones", + "traits": { + "smithy.api#documentation": "A complex type that contains general information about the hosted zone.
", + "smithy.api#required": {} + } + }, + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "For the second and subsequent calls to ListHostedZones,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.
A flag indicating whether there are more hosted zones to be listed. If the response\n\t\t\twas truncated, you can get more hosted zones by submitting another\n\t\t\t\tListHostedZones request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.
If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the first hosted zone in the next group of hosted zones. Submit another\n\t\t\t\tListHostedZones request, and specify the value of\n\t\t\t\tNextMarker from the response in the marker\n\t\t\tparameter.
This element is present only if IsTruncated is true.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListHostedZones that produced the current response.
Lists the configurations for DNS query logging that are associated with the current\n\t\t\t\tAmazon Web Services account or the configuration that is associated with a specified\n\t\t\thosted zone.
\nFor more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of\n\t\t\tDNS query logs, appears in Logging DNS Queries in\n\t\t\tthe Amazon Route 53 Developer Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/queryloggingconfig", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QueryLoggingConfigs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53#ListQueryLoggingConfigsRequest": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "(Optional) If you want to list the query logging configuration that is associated with\n\t\t\ta hosted zone, specify the ID in HostedZoneId.
If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns\n\t\t\tall of the configurations that are associated with the current Amazon Web Services account.
(Optional) If the current Amazon Web Services account has more than\n\t\t\t\tMaxResults query logging configurations, use NextToken to\n\t\t\tget the second and subsequent pages of results.
For the first ListQueryLoggingConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from\n\t\t\tthe previous response and specify that value for NextToken in the\n\t\t\trequest.
(Optional) The maximum number of query logging configurations that you want Amazon\n\t\t\tRoute 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the\n\t\t\tvalue of NextToken in the response to get the next page of results.
If you don't specify a value for MaxResults, Route 53 returns up to 100\n\t\t\tconfigurations.
An array that contains one QueryLoggingConfig element for each configuration for DNS query logging\n\t\t\tthat is associated with the current Amazon Web Services account.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "If a response includes the last of the query logging configurations that are\n\t\t\tassociated with the current Amazon Web Services account, NextToken doesn't\n\t\t\tappear in the response.
If a response doesn't include the last of the configurations, you can get more\n\t\t\tconfigurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken\n\t\t\tthat Amazon Route 53 returned in the previous response and include it in\n\t\t\t\tNextToken in the next request.
Lists the resource record sets in a specified hosted zone.
\n\n ListResourceRecordSets returns up to 300 resource record sets at a time\n\t\t\tin ASCII order, beginning at a position specified by the name and\n\t\t\t\ttype elements.
\n Sort order\n
\n\n ListResourceRecordSets sorts results first by DNS name with the labels\n\t\t\treversed, for example:
\n com.example.www.\n
Note the trailing dot, which can change the sort order when the record name contains\n\t\t\tcharacters that appear before . (decimal 46) in the ASCII table. These\n\t\t\tcharacters include the following: ! \" # $ % & ' ( ) * + , -\n
When multiple records have the same DNS name, ListResourceRecordSets\n\t\t\tsorts results by the record type.
\n Specifying where to start listing records\n
\nYou can use the name and type elements to specify the resource record set that the\n\t\t\tlist begins with:
\nThe results begin with the first resource record set that the hosted zone\n\t\t\t\t\t\tcontains.
\nThe results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name.
Amazon Route 53 returns the InvalidInput error.
The results begin with the first resource record set in the list whose\n\t\t\t\t\t\tname is greater than or equal to Name, and whose type is\n\t\t\t\t\t\tgreater than or equal to Type.
\n Resource record sets that are PENDING\n
\nThis action returns the most current version of the records. This includes records\n\t\t\tthat are PENDING, and that are not yet available on all Route 53 DNS\n\t\t\tservers.
\n Changing resource record sets\n
\nTo ensure that you get an accurate listing of the resource record sets for a hosted\n\t\t\tzone at a point in time, do not submit a ChangeResourceRecordSets request\n\t\t\twhile you're paging through the results of a ListResourceRecordSets\n\t\t\trequest. If you do, some pages may display results without the latest changes while\n\t\t\tother pages display results with the latest changes.
\n Displaying the next page of results\n
\nIf a ListResourceRecordSets command returns more than one page of\n\t\t\tresults, the value of IsTruncated is true. To display the next\n\t\t\tpage of results, get the values of NextRecordName,\n\t\t\t\tNextRecordType, and NextRecordIdentifier (if any) from the\n\t\t\tresponse. Then submit another ListResourceRecordSets request, and specify\n\t\t\tthose values for StartRecordName, StartRecordType, and\n\t\t\t\tStartRecordIdentifier.
The ID of the hosted zone that contains the resource record sets that you want to\n\t\t\tlist.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartRecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "The first name in the lexicographic ordering of resource record sets that you want to\n\t\t\tlist. If the specified record name doesn't exist, the results begin with the first\n\t\t\tresource record set that has a name greater than the value of name.
The type of resource record set to begin the record listing from.
\nValid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | MX | NAPTR |\n\t\t\t\tNS | PTR | SOA | SPF |\n\t\t\t\tSRV | TXT\n
Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT\n
Values for alias resource record sets:
\n\n API Gateway custom regional API or edge-optimized\n\t\t\t\t\t\tAPI: A
\n\n CloudFront distribution: A or AAAA
\n\n Elastic Beanstalk environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A
\n\n Elastic Load Balancing load balancer: A |\n\t\t\t\t\tAAAA
\n\n S3 bucket: A
\n\n VPC interface VPC endpoint: A
\n\n Another resource record set in this hosted\n\t\t\t\t\t\tzone: The type of the resource record set that the alias\n\t\t\t\t\treferences.
\nConstraint: Specifying type without specifying name returns\n\t\t\tan InvalidInput error.
\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, specify\n\t\t\tthe value of NextRecordIdentifier from the previous response to get the\n\t\t\tnext resource record set that has the current DNS name and type.
(Optional) The maximum number of resource records sets to include in the response body\n\t\t\tfor this request. If the response includes more than maxitems resource\n\t\t\trecord sets, the value of the IsTruncated element in the response is\n\t\t\t\ttrue, and the values of the NextRecordName and\n\t\t\t\tNextRecordType elements in the response identify the first resource\n\t\t\trecord set in the next group of maxitems resource record sets.
A request for the resource record sets that are associated with a specified hosted\n\t\t\tzone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListResourceRecordSetsResponse": { + "type": "structure", + "members": { + "ResourceRecordSets": { + "target": "com.amazonaws.route53#ResourceRecordSets", + "traits": { + "smithy.api#documentation": "Information about multiple resource record sets.
", + "smithy.api#required": {} + } + }, + "IsTruncated": { + "target": "com.amazonaws.route53#PageTruncated", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A flag that indicates whether more resource record sets remain to be listed. If your\n\t\t\tresults were truncated, you can make a follow-up pagination request by using the\n\t\t\t\tNextRecordName element.
If the results were truncated, the name of the next record in the list.
\nThis element is present only if IsTruncated is true.
If the results were truncated, the type of the next record in the list.
\nThis element is present only if IsTruncated is true.
\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: If results were truncated for a given DNS name and type, the\n\t\t\tvalue of SetIdentifier for the next resource record set that has the\n\t\t\tcurrent DNS name and type.
For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.
" + } + }, + "MaxItems": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The maximum number of records you requested.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains list information for the resource record set.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListReusableDelegationSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListReusableDelegationSetsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListReusableDelegationSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of the reusable delegation sets that are associated with the current\n\t\t\t\tAmazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/delegationset", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListReusableDelegationSetsRequest": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more reusable delegation sets. To get another group,\n\t\t\tsubmit another ListReusableDelegationSets request.
For the value of marker, specify the value of NextMarker\n\t\t\tfrom the previous response, which is the ID of the first reusable delegation set that\n\t\t\tAmazon Route 53 will return if you submit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more reusable delegation sets to get.
The number of reusable delegation sets that you want Amazon Route 53 to return in the\n\t\t\tresponse to this request. If you specify a value greater than 100, Route 53 returns only\n\t\t\tthe first 100 reusable delegation sets.
", + "smithy.api#httpQuery": "maxitems" + } + } + }, + "traits": { + "smithy.api#documentation": "A request to get a list of the reusable delegation sets that are associated with the\n\t\t\tcurrent Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListReusableDelegationSetsResponse": { + "type": "structure", + "members": { + "DelegationSets": { + "target": "com.amazonaws.route53#DelegationSets", + "traits": { + "smithy.api#documentation": "A complex type that contains one DelegationSet element for each reusable\n\t\t\tdelegation set that was created by the current Amazon Web Services account.
For the second and subsequent calls to ListReusableDelegationSets,\n\t\t\t\tMarker is the value that you specified for the marker\n\t\t\tparameter in the request that produced the current response.
A flag that indicates whether there are more reusable delegation sets to be\n\t\t\tlisted.
", + "smithy.api#required": {} + } + }, + "NextMarker": { + "target": "com.amazonaws.route53#PageMarker", + "traits": { + "smithy.api#documentation": "If IsTruncated is true, the value of NextMarker\n\t\t\tidentifies the next reusable delegation set that Amazon Route 53 will return if you\n\t\t\tsubmit another ListReusableDelegationSets request and specify the value of\n\t\t\t\tNextMarker in the marker parameter.
The value that you specified for the maxitems parameter in the call to\n\t\t\t\tListReusableDelegationSets that produced the current response.
A complex type that contains information about the reusable delegation sets that are\n\t\t\tassociated with the current Amazon Web Services account.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Lists tags for one health check or hosted zone.
\nFor information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
The ID of the resource for which you want to retrieve tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type containing information about a request for a list of the tags that are\n\t\t\tassociated with an individual resource.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceTagSet": { + "target": "com.amazonaws.route53#ResourceTagSet", + "traits": { + "smithy.api#documentation": "A ResourceTagSet containing tags associated with the specified\n\t\t\tresource.
A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTagsForResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTagsForResourcesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTagsForResourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + }, + { + "target": "com.amazonaws.route53#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Lists tags for up to 10 health checks or hosted zones.
\nFor information about using tags for cost allocation, see Using Cost Allocation\n\t\t\t\tTags in the Billing and Cost Management User Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/tags/{ResourceType}", + "code": 200 + } + } + }, + "com.amazonaws.route53#ListTagsForResourcesRequest": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "The type of the resources.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
A complex type that contains the ResourceId element for each resource for which you\n\t\t\twant to get a list of tags.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the health checks or hosted zones for\n\t\t\twhich you want to list tags.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTagsForResourcesResponse": { + "type": "structure", + "members": { + "ResourceTagSets": { + "target": "com.amazonaws.route53#ResourceTagSetList", + "traits": { + "smithy.api#documentation": "A list of ResourceTagSets containing tags associated with the specified\n\t\t\tresources.
A complex type containing tags for the specified resources.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the latest version for every traffic policy that is associated\n\t\t\twith the current Amazon Web Services account. Policies are listed in the order that they\n\t\t\twere created in.
\nFor information about how of deleting a traffic policy affects the response from\n\t\t\t\tListTrafficPolicies, see DeleteTrafficPolicy.
(Conditional) For your first request to ListTrafficPolicies, don't\n\t\t\tinclude the TrafficPolicyIdMarker parameter.
If you have more traffic policies than the value of MaxItems,\n\t\t\t\tListTrafficPolicies returns only the first MaxItems\n\t\t\ttraffic policies. To get the next group of policies, submit another request to\n\t\t\t\tListTrafficPolicies. For the value of\n\t\t\t\tTrafficPolicyIdMarker, specify the value of\n\t\t\t\tTrafficPolicyIdMarker that was returned in the previous\n\t\t\tresponse.
(Optional) The maximum number of traffic policies that you want Amazon Route 53 to\n\t\t\treturn in response to this request. If you have more than MaxItems traffic\n\t\t\tpolicies, the value of IsTruncated in the response is true,\n\t\t\tand the value of TrafficPolicyIdMarker is the ID of the first traffic\n\t\t\tpolicy that Route 53 will return if you submit another request.
A complex type that contains the information about the request to list the traffic\n\t\t\tpolicies that are associated with the current Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPoliciesResponse": { + "type": "structure", + "members": { + "TrafficPolicySummaries": { + "target": "com.amazonaws.route53#TrafficPolicySummaries", + "traits": { + "smithy.api#documentation": "A list that contains one TrafficPolicySummary element for each traffic\n\t\t\tpolicy that was created by the current Amazon Web Services account.
A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicies request and specifying the value of\n\t\t\t\tTrafficPolicyIdMarker in the TrafficPolicyIdMarker request\n\t\t\tparameter.
If the value of IsTruncated is true,\n\t\t\t\tTrafficPolicyIdMarker is the ID of the first traffic policy in the next\n\t\t\tgroup of MaxItems traffic policies.
The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicies request that produced the current response.
A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the traffic policy instances that you created by using the\n\t\t\tcurrent Amazon Web Services account.
\nAfter you submit an UpdateTrafficPolicyInstance request, there's a\n\t\t\t\tbrief delay while Amazon Route 53 creates the resource record sets that are\n\t\t\t\tspecified in the traffic policy definition. For more information, see the\n\t\t\t\t\tState response element.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.
Gets information about the traffic policy instances that you created in a specified\n\t\t\thosted zone.
\nAfter you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.
The ID of the hosted zone that you want to list traffic policy instances for.
", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "TrafficPolicyInstanceNameMarker": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response is true, you have\n\t\t\tmore traffic policy instances. To get more traffic policy instances, submit another\n\t\t\t\tListTrafficPolicyInstances request. For the value of\n\t\t\t\ttrafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.
A request for the traffic policy instances that you created in a specified hosted\n\t\t\tzone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByHostedZoneResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of traffic policy instances.
If IsTruncated is true, TrafficPolicyInstanceTypeMarker is\n\t\t\tthe DNS type of the resource record sets that are associated with the first traffic\n\t\t\tpolicy instance in the next group of traffic policy instances.
A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tsubmitting another ListTrafficPolicyInstancesByHostedZone request and\n\t\t\tspecifying the values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.
The value that you specified for the MaxItems parameter in the\n\t\t\t\tListTrafficPolicyInstancesByHostedZone request that produced the\n\t\t\tcurrent response.
A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the traffic policy instances that you created by using a\n\t\t\tspecify traffic policy version.
\nAfter you submit a CreateTrafficPolicyInstance or an\n\t\t\t\t\tUpdateTrafficPolicyInstance request, there's a brief delay while\n\t\t\t\tAmazon Route 53 creates the resource record sets that are specified in the traffic\n\t\t\t\tpolicy definition. For more information, see the State response\n\t\t\t\telement.
Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic\n\t\t\tpolicy instances, you can use the MaxItems parameter to list them in groups\n\t\t\tof up to 100.
The ID of the traffic policy for which you want to list traffic policy\n\t\t\tinstances.
", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version of the traffic policy for which you want to list traffic policy instances.\n\t\t\tThe version must be associated with the traffic policy that is specified by\n\t\t\t\tTrafficPolicyId.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.
For the value of hostedzoneid, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance that Amazon Route 53 will return if you submit\n\t\t\tanother request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.
For the value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstancesByPolicy\n\t\t\trequest.
For the value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance that Amazon Route 53 will return if you\n\t\t\tsubmit another request.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
The maximum number of traffic policy instances to be included in the response body for\n\t\t\tthis request. If you have more than MaxItems traffic policy instances, the\n\t\t\tvalue of the IsTruncated element in the response is true, and\n\t\t\tthe values of HostedZoneIdMarker,\n\t\t\t\tTrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance that Amazon Route 53 will return if you submit another request.
A complex type that contains the information about the request to list your traffic\n\t\t\tpolicy instances.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesByPolicyResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.
If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance in the next group of\n\t\t\ttraffic policy instances.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance in the next group of\n\t\t\t\tMaxItems traffic policy instances.
A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get the next group of traffic policy instances by\n\t\t\tcalling ListTrafficPolicyInstancesByPolicy again and specifying the values\n\t\t\tof the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker elements in the corresponding request\n\t\t\tparameters.
The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstancesByPolicy that produced the current\n\t\t\tresponse.
A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesRequest": { + "type": "structure", + "members": { + "HostedZoneIdMarker": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of HostedZoneId, specify the value of\n\t\t\t\tHostedZoneIdMarker from the previous response, which is the hosted zone\n\t\t\tID of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancename, specify the value of\n\t\t\t\tTrafficPolicyInstanceNameMarker from the previous response, which is\n\t\t\tthe name of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
If the value of IsTruncated in the previous response was\n\t\t\t\ttrue, you have more traffic policy instances. To get more traffic\n\t\t\tpolicy instances, submit another ListTrafficPolicyInstances request. For\n\t\t\tthe value of trafficpolicyinstancetype, specify the value of\n\t\t\t\tTrafficPolicyInstanceTypeMarker from the previous response, which is\n\t\t\tthe type of the first traffic policy instance in the next group of traffic policy\n\t\t\tinstances.
If the value of IsTruncated in the previous response was\n\t\t\t\tfalse, there are no more traffic policy instances to get.
The maximum number of traffic policy instances that you want Amazon Route 53 to return\n\t\t\tin response to a ListTrafficPolicyInstances request. If you have more than\n\t\t\t\tMaxItems traffic policy instances, the value of the\n\t\t\t\tIsTruncated element in the response is true, and the\n\t\t\tvalues of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker,\n\t\t\tand TrafficPolicyInstanceTypeMarker represent the first traffic policy\n\t\t\tinstance in the next group of MaxItems traffic policy instances.
A request to get information about the traffic policy instances that you created by\n\t\t\tusing the current Amazon Web Services account.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyInstancesResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstances": { + "target": "com.amazonaws.route53#TrafficPolicyInstances", + "traits": { + "smithy.api#documentation": "A list that contains one TrafficPolicyInstance element for each traffic\n\t\t\tpolicy instance that matches the elements in the request.
If IsTruncated is true, HostedZoneIdMarker is\n\t\t\tthe ID of the hosted zone of the first traffic policy instance that Route 53 will return\n\t\t\tif you submit another ListTrafficPolicyInstances request.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceNameMarker is the name of the first traffic policy\n\t\t\tinstance that Route 53 will return if you submit another\n\t\t\t\tListTrafficPolicyInstances request.
If IsTruncated is true,\n\t\t\t\tTrafficPolicyInstanceTypeMarker is the DNS type of the resource record\n\t\t\tsets that are associated with the first traffic policy instance that Amazon Route 53\n\t\t\twill return if you submit another ListTrafficPolicyInstances request.\n\t\t
A flag that indicates whether there are more traffic policy instances to be listed. If\n\t\t\tthe response was truncated, you can get more traffic policy instances by calling\n\t\t\t\tListTrafficPolicyInstances again and specifying the values of the\n\t\t\t\tHostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and\n\t\t\t\tTrafficPolicyInstanceTypeMarker in the corresponding request\n\t\t\tparameters.
The value that you specified for the MaxItems parameter in the call to\n\t\t\t\tListTrafficPolicyInstances that produced the current response.
A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListTrafficPolicyVersionsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListTrafficPolicyVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about all of the versions for a specified traffic policy.
\nTraffic policy versions are listed in numerical order by\n\t\t\tVersionNumber.
Specify the value of Id of the traffic policy for which you want to list\n\t\t\tall versions.
For your first request to ListTrafficPolicyVersions, don't include the\n\t\t\t\tTrafficPolicyVersionMarker parameter.
If you have more traffic policy versions than the value of MaxItems,\n\t\t\t\tListTrafficPolicyVersions returns only the first group of\n\t\t\t\tMaxItems versions. To get more traffic policy versions, submit another\n\t\t\t\tListTrafficPolicyVersions request. For the value of\n\t\t\t\tTrafficPolicyVersionMarker, specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the previous response.
The maximum number of traffic policy versions that you want Amazon Route 53 to include\n\t\t\tin the response body for this request. If the specified traffic policy has more than\n\t\t\t\tMaxItems versions, the value of IsTruncated in the\n\t\t\tresponse is true, and the value of the\n\t\t\t\tTrafficPolicyVersionMarker element is the ID of the first version that\n\t\t\tRoute 53 will return if you submit another request.
A complex type that contains the information about the request to list your traffic\n\t\t\tpolicies.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListTrafficPolicyVersionsResponse": { + "type": "structure", + "members": { + "TrafficPolicies": { + "target": "com.amazonaws.route53#TrafficPolicies", + "traits": { + "smithy.api#documentation": "A list that contains one TrafficPolicy element for each traffic policy\n\t\t\tversion that is associated with the specified traffic policy.
A flag that indicates whether there are more traffic policies to be listed. If the\n\t\t\tresponse was truncated, you can get the next group of traffic policies by submitting\n\t\t\tanother ListTrafficPolicyVersions request and specifying the value of\n\t\t\t\tNextMarker in the marker parameter.
If IsTruncated is true, the value of\n\t\t\t\tTrafficPolicyVersionMarker identifies the first traffic policy that\n\t\t\tAmazon Route 53 will return if you submit another request. Call\n\t\t\t\tListTrafficPolicyVersions again and specify the value of\n\t\t\t\tTrafficPolicyVersionMarker in the\n\t\t\t\tTrafficPolicyVersionMarker request parameter.
This element is present only if IsTruncated is true.
The value that you specified for the maxitems parameter in the\n\t\t\t\tListTrafficPolicyVersions request that produced the current\n\t\t\tresponse.
A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizations": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsRequest" + }, + "output": { + "target": "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#InvalidPaginationToken" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of the VPCs that were created by other accounts and that can be associated\n\t\t\twith a specified hosted zone because you've submitted one or more\n\t\t\t\tCreateVPCAssociationAuthorization requests.
The response includes a VPCs element with a VPC child\n\t\t\telement for each VPC that can be associated with the hosted zone.
The ID of the hosted zone for which you want a list of VPCs that can be associated\n\t\t\twith the hosted zone.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "\n Optional: If a response includes a NextToken\n\t\t\telement, there are more VPCs that can be associated with the specified hosted zone. To\n\t\t\tget the next page of results, submit another request, and include the value of\n\t\t\t\tNextToken from the response in the nexttoken parameter in\n\t\t\tanother ListVPCAssociationAuthorizations request.
\n Optional: An integer that specifies the maximum number of VPCs\n\t\t\tthat you want Amazon Route 53 to return. If you don't specify a value for\n\t\t\t\tMaxResults, Route 53 returns up to 50 VPCs per page.
A complex type that contains information about that can be associated with your hosted\n\t\t\tzone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#ListVPCAssociationAuthorizationsResponse": { + "type": "structure", + "members": { + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the hosted zone that you can associate the listed VPCs with.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.route53#PaginationToken", + "traits": { + "smithy.api#documentation": "When the response includes a NextToken element, there are more VPCs that\n\t\t\tcan be associated with the specified hosted zone. To get the next page of VPCs, submit\n\t\t\tanother ListVPCAssociationAuthorizations request, and include the value of\n\t\t\tthe NextToken element from the response in the nexttoken\n\t\t\trequest parameter.
The list of VPCs that are authorized to be associated with the specified hosted\n\t\t\tzone.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the request.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#LocationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#LocationSummary" + } + }, + "com.amazonaws.route53#LocationSummary": { + "type": "structure", + "members": { + "LocationName": { + "target": "com.amazonaws.route53#CidrLocationNameDefaultAllowed", + "traits": { + "smithy.api#documentation": "A string that specifies a location name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the CIDR location.
" + } + }, + "com.amazonaws.route53#MeasureLatency": { + "type": "boolean" + }, + "com.amazonaws.route53#Message": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#MetricName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#Nameserver": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#NoSuchChange": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "A change with the specified change ID does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCidrCollectionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The CIDR collection you specified, doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCidrLocationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The CIDR collection location doesn't match any locations in your account.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchCloudWatchLogsLogGroup": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "There is no CloudWatch Logs log group with the specified ARN.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchDelegationSet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "A reusable delegation set with the specified ID does not exist.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#NoSuchGeoLocation": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "Amazon Route 53 doesn't support the specified geographic location. For a list of\n\t\t\tsupported geolocation codes, see the GeoLocation data\n\t\t\ttype.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchHealthCheck": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "No health check exists with the specified ID.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchHostedZone": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "No hosted zone exists with the ID that you specified.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchKeySigningKey": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified key-signing key (KSK) doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchQueryLoggingConfig": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "There is no DNS query logging configuration with the specified ID.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchTrafficPolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "No traffic policy exists with the specified ID.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#NoSuchTrafficPolicyInstance": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "No traffic policy instance exists with the specified ID.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#Nonce": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53#NotAuthorizedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "Associating the specified VPC with the specified hosted zone has not been\n\t\t\tauthorized.
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.route53#PageMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#PageTruncated": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.route53#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#Period": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60 + } + } + }, + "com.amazonaws.route53#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.route53#PriorRequestNotComplete": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "If Amazon Route 53 can't process a request before the next request arrives, it will\n\t\t\treject subsequent requests for the same hosted zone and return an HTTP 400\n\t\t\t\terror (Bad request). If Route 53 returns this error repeatedly\n\t\t\tfor the same request, we recommend that you wait, in intervals of increasing duration,\n\t\t\tbefore you try the request again.
You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't\n\t\t\tsupport associating a VPC with a public hosted zone.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#QueryLoggingConfig": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#QueryLoggingConfigId", + "traits": { + "smithy.api#documentation": "The ID for a configuration for DNS query logging.
", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the hosted zone that CloudWatch Logs is logging queries for.
", + "smithy.api#required": {} + } + }, + "CloudWatchLogsLogGroupArn": { + "target": "com.amazonaws.route53#CloudWatchLogsLogGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53\n\t\t\tis publishing logs to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about a configuration for DNS query\n\t\t\tlogging.
" + } + }, + "com.amazonaws.route53#QueryLoggingConfigAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You can create only one query logging configuration for a hosted zone, and a query\n\t\t\tlogging configuration already exists for this hosted zone.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#QueryLoggingConfigId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#QueryLoggingConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#QueryLoggingConfig", + "traits": { + "smithy.api#xmlName": "QueryLoggingConfig" + } + } + }, + "com.amazonaws.route53#RData": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4000 + } + } + }, + "com.amazonaws.route53#RRType": { + "type": "enum", + "members": { + "SOA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOA" + } + }, + "A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A" + } + }, + "TXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TXT" + } + }, + "NS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NS" + } + }, + "CNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CNAME" + } + }, + "MX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MX" + } + }, + "NAPTR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAPTR" + } + }, + "PTR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTR" + } + }, + "SRV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SRV" + } + }, + "SPF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPF" + } + }, + "AAAA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AAAA" + } + }, + "CAA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAA" + } + }, + "DS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DS" + } + } + } + }, + "com.amazonaws.route53#RecordData": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#RecordDataEntry", + "traits": { + "smithy.api#xmlName": "RecordDataEntry" + } + } + }, + "com.amazonaws.route53#RecordDataEntry": { + "type": "string", + "traits": { + "smithy.api#documentation": "A value that Amazon Route 53 returned for this resource record set. A\n\t\t\t\tRecordDataEntry element is one of the following:
For non-alias resource record sets, a RecordDataEntry element\n\t\t\t\t\tcontains one value in the resource record set. If the resource record set\n\t\t\t\t\tcontains multiple values, the response includes one RecordDataEntry\n\t\t\t\t\telement for each value.
For multiple resource record sets that have the same name and type, which\n\t\t\t\t\tincludes weighted, latency, geolocation, and failover, a\n\t\t\t\t\t\tRecordDataEntry element contains the value from the appropriate\n\t\t\t\t\tresource record set based on the request.
For alias resource record sets that refer to Amazon Web Services resources\n\t\t\t\t\tother than another resource record set, the RecordDataEntry element\n\t\t\t\t\tcontains an IP address or a domain name for the Amazon Web Services resource,\n\t\t\t\t\tdepending on the type of resource.
For alias resource record sets that refer to other resource record sets, a\n\t\t\t\t\t\tRecordDataEntry element contains one value from the referenced\n\t\t\t\t\tresource record set. If the referenced resource record set contains multiple\n\t\t\t\t\tvalues, the response includes one RecordDataEntry element for each\n\t\t\t\t\tvalue.
The current or new DNS record value, not to exceed 4,000 characters. In the case of a\n\t\t\t\tDELETE action, if the current value does not match the actual value, an\n\t\t\terror is returned. For descriptions about how to format Value for different\n\t\t\trecord types, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.
You can specify more than one value for all record types except CNAME and\n\t\t\t\tSOA.
If you're creating an alias resource record set, omit Value.
Information specific to the resource record.
\nIf you're creating an alias resource record set, omit\n\t\t\t\tResourceRecord.
For ChangeResourceRecordSets requests, the name of the record that you\n\t\t\twant to create, update, or delete. For ListResourceRecordSets responses,\n\t\t\tthe name of a record in the specified hosted zone.
\n ChangeResourceRecordSets Only\n
\nEnter a fully qualified domain name, for example, www.example.com. You\n\t\t\tcan optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53\n\t\t\tassumes that the domain name that you specify is fully qualified. This means that Route\n\t\t\t53 treats www.example.com (without a trailing dot) and\n\t\t\t\twww.example.com. (with a trailing dot) as identical.
For information about how to specify characters other than a-z,\n\t\t\t\t0-9, and - (hyphen) and how to specify internationalized\n\t\t\tdomain names, see DNS Domain Name\n\t\t\t\tFormat in the Amazon Route 53 Developer Guide.
You can use the asterisk (*) wildcard to replace the leftmost label in a domain name,\n\t\t\tfor example, *.example.com. Note the following:
The * must replace the entire label. For example, you can't specify\n\t\t\t\t\t\t*prod.example.com or prod*.example.com.
The * can't replace any of the middle labels, for example,\n\t\t\t\t\tmarketing.*.example.com.
\nIf you include * in any position other than the leftmost label in a domain\n\t\t\t\t\tname, DNS treats it as an * character (ASCII 42), not as a wildcard.
\nYou can't use the * wildcard for resource records sets that have a type of\n\t\t\t\t\t\tNS.
\nThe DNS record type. For information about different record types and how data is\n\t\t\tencoded for them, see Supported DNS Resource\n\t\t\t\tRecord Types in the Amazon Route 53 Developer\n\t\t\tGuide.
\nValid values for basic resource record sets: A | AAAA |\n\t\t\t\tCAA | CNAME | DS |MX |\n\t\t\t\tNAPTR | NS | PTR | SOA |\n\t\t\t\tSPF | SRV | TXT\n
Values for weighted, latency, geolocation, and failover resource record sets:\n\t\t\t\tA | AAAA | CAA | CNAME |\n\t\t\t\tMX | NAPTR | PTR | SPF |\n\t\t\t\tSRV | TXT. When creating a group of weighted, latency,\n\t\t\tgeolocation, or failover resource record sets, specify the same value for all of the\n\t\t\tresource record sets in the group.
Valid values for multivalue answer resource record sets: A |\n\t\t\t\tAAAA | MX | NAPTR | PTR |\n\t\t\t\tSPF | SRV | TXT\n
SPF records were formerly used to verify the identity of the sender of email\n\t\t\t\tmessages. However, we no longer recommend that you create resource record sets for\n\t\t\t\twhich the value of Type is SPF. RFC 7208, Sender\n\t\t\t\t\tPolicy Framework (SPF) for Authorizing Use of Domains in Email, Version\n\t\t\t\t\t1, has been updated to say, \"...[I]ts existence and mechanism defined\n\t\t\t\tin [RFC4408] have led to some interoperability issues. Accordingly, its use is no\n\t\t\t\tlonger appropriate for SPF version 1; implementations are not to use it.\" In RFC\n\t\t\t\t7208, see section 14.1, The SPF DNS Record Type.
Values for alias resource record sets:
\n\n Amazon API Gateway custom regional APIs and\n\t\t\t\t\t\tedge-optimized APIs:\n A\n
\n CloudFront distributions:\n A\n
If IPv6 is enabled for the distribution, create two resource record sets to\n\t\t\t\t\troute traffic to your distribution, one with a value of A and one\n\t\t\t\t\twith a value of AAAA.
\n Amazon API Gateway environment that has a regionalized\n\t\t\t\t\t\tsubdomain: A\n
\n ELB load balancers:\n A | AAAA\n
\n Amazon S3 buckets:\n A\n
\n Amazon Virtual Private Cloud interface VPC\n\t\t\t\t\t\tendpoints\n A\n
\n Another resource record set in this hosted\n\t\t\t\t\t\tzone: Specify the type of the resource record set that you're\n\t\t\t\t\tcreating the alias for. All values are supported except NS and\n\t\t\t\t\t\tSOA.
If you're creating an alias record that has the same name as the hosted\n\t\t\t\t\t\tzone (known as the zone apex), you can't route traffic to a record for which\n\t\t\t\t\t\tthe value of Type is CNAME. This is because the\n\t\t\t\t\t\talias record must have the same type as the record you're routing traffic\n\t\t\t\t\t\tto, and creating a CNAME record for the zone apex isn't supported even for\n\t\t\t\t\t\tan alias record.
\n Resource record sets that have a routing policy other than\n\t\t\t\tsimple: An identifier that differentiates among multiple resource record\n\t\t\tsets that have the same combination of name and type, such as multiple weighted resource\n\t\t\trecord sets named acme.example.com that have a type of A. In a group of resource record\n\t\t\tsets that have the same name and type, the value of SetIdentifier must be\n\t\t\tunique for each resource record set.
For information about routing policies, see Choosing a Routing\n\t\t\t\tPolicy in the Amazon Route 53 Developer Guide.
" + } + }, + "Weight": { + "target": "com.amazonaws.route53#ResourceRecordSetWeight", + "traits": { + "smithy.api#documentation": "\n Weighted resource record sets only: Among resource record sets\n\t\t\tthat have the same combination of DNS name and type, a value that determines the\n\t\t\tproportion of DNS queries that Amazon Route 53 responds to using the current resource\n\t\t\trecord set. Route 53 calculates the sum of the weights for the resource record sets that\n\t\t\thave the same combination of DNS name and type. Route 53 then responds to queries based\n\t\t\ton the ratio of a resource's weight to the total. Note the following:
\nYou must specify a value for the Weight element for every\n\t\t\t\t\tweighted resource record set.
You can only specify one ResourceRecord per weighted resource\n\t\t\t\t\trecord set.
You can't create latency, failover, or geolocation resource record sets that\n\t\t\t\t\thave the same values for the Name and Type elements as\n\t\t\t\t\tweighted resource record sets.
You can create a maximum of 100 weighted resource record sets that have the\n\t\t\t\t\tsame values for the Name and Type elements.
For weighted (but not weighted alias) resource record sets, if you set\n\t\t\t\t\t\tWeight to 0 for a resource record set, Route 53\n\t\t\t\t\tnever responds to queries with the applicable value for that resource record\n\t\t\t\t\tset. However, if you set Weight to 0 for all resource\n\t\t\t\t\trecord sets that have the same combination of DNS name and type, traffic is\n\t\t\t\t\trouted to all resources with equal probability.
The effect of setting Weight to 0 is different when\n\t\t\t\t\tyou associate health checks with weighted resource record sets. For more\n\t\t\t\t\tinformation, see Options for Configuring Route 53 Active-Active and Active-Passive\n\t\t\t\t\t\tFailover in the Amazon Route 53 Developer\n\t\t\t\t\tGuide.
\n Latency-based resource record sets only: The Amazon EC2 Region\n\t\t\twhere you created the resource that this resource record set refers to. The resource\n\t\t\ttypically is an Amazon Web Services resource, such as an EC2 instance or an ELB load\n\t\t\tbalancer, and is referred to by an IP address or a DNS domain name, depending on the\n\t\t\trecord type.
\nWhen Amazon Route 53 receives a DNS query for a domain name and type for which you\n\t\t\thave created latency resource record sets, Route 53 selects the latency resource record\n\t\t\tset that has the lowest latency between the end user and the associated Amazon EC2\n\t\t\tRegion. Route 53 then returns the value that is associated with the selected resource\n\t\t\trecord set.
\nNote the following:
\nYou can only specify one ResourceRecord per latency resource\n\t\t\t\t\trecord set.
You can only create one latency resource record set for each Amazon EC2\n\t\t\t\t\tRegion.
\nYou aren't required to create latency resource record sets for all Amazon EC2\n\t\t\t\t\tRegions. Route 53 will choose the region with the best latency from among the\n\t\t\t\t\tregions that you create latency resource record sets for.
\nYou can't create non-latency resource record sets that have the same values\n\t\t\t\t\tfor the Name and Type elements as latency resource\n\t\t\t\t\trecord sets.
\n Geolocation resource record sets only: A complex type that lets\n\t\t\tyou control how Amazon Route 53 responds to DNS queries based on the geographic origin\n\t\t\tof the query. For example, if you want all queries from Africa to be routed to a web\n\t\t\tserver with an IP address of 192.0.2.111, create a resource record set with\n\t\t\ta Type of A and a ContinentCode of\n\t\t\t\tAF.
Although creating geolocation and geolocation alias resource record sets in a\n\t\t\t\tprivate hosted zone is allowed, it's not supported.
\nIf you create separate resource record sets for overlapping geographic regions (for\n\t\t\texample, one resource record set for a continent and one for a country on the same\n\t\t\tcontinent), priority goes to the smallest geographic region. This allows you to route\n\t\t\tmost queries for a continent to one resource and to route queries for a country on that\n\t\t\tcontinent to a different resource.
\nYou can't create two geolocation resource record sets that specify the same geographic\n\t\t\tlocation.
\nThe value * in the CountryCode element matches all\n\t\t\tgeographic locations that aren't specified in other geolocation resource record sets\n\t\t\tthat have the same values for the Name and Type\n\t\t\telements.
Geolocation works by mapping IP addresses to locations. However, some IP addresses\n\t\t\t\taren't mapped to geographic locations, so even if you create geolocation resource\n\t\t\t\trecord sets that cover all seven continents, Route 53 will receive some DNS queries\n\t\t\t\tfrom locations that it can't identify. We recommend that you create a resource\n\t\t\t\trecord set for which the value of CountryCode is *. Two\n\t\t\t\tgroups of queries are routed to the resource that you specify in this record:\n\t\t\t\tqueries that come from locations for which you haven't created geolocation resource\n\t\t\t\trecord sets and queries from IP addresses that aren't mapped to a location. If you\n\t\t\t\tdon't create a * resource record set, Route 53 returns a \"no answer\"\n\t\t\t\tresponse for queries from those locations.
You can't create non-geolocation resource record sets that have the same values for\n\t\t\tthe Name and Type elements as geolocation resource record\n\t\t\tsets.
\n Failover resource record sets only: To configure failover, you\n\t\t\tadd the Failover element to two resource record sets. For one resource\n\t\t\trecord set, you specify PRIMARY as the value for Failover; for\n\t\t\tthe other resource record set, you specify SECONDARY. In addition, you\n\t\t\tinclude the HealthCheckId element and specify the health check that you\n\t\t\twant Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you have included the\n\t\t\t\tHealthCheckId element in both resource record sets:
When the primary resource record set is healthy, Route 53 responds to DNS\n\t\t\t\t\tqueries with the applicable value from the primary resource record set\n\t\t\t\t\tregardless of the health of the secondary resource record set.
\nWhen the primary resource record set is unhealthy and the secondary resource\n\t\t\t\t\trecord set is healthy, Route 53 responds to DNS queries with the applicable\n\t\t\t\t\tvalue from the secondary resource record set.
\nWhen the secondary resource record set is unhealthy, Route 53 responds to DNS\n\t\t\t\t\tqueries with the applicable value from the primary resource record set\n\t\t\t\t\tregardless of the health of the primary resource record set.
\nIf you omit the HealthCheckId element for the secondary resource\n\t\t\t\t\trecord set, and if the primary resource record set is unhealthy, Route 53 always\n\t\t\t\t\tresponds to DNS queries with the applicable value from the secondary resource\n\t\t\t\t\trecord set. This is true regardless of the health of the associated\n\t\t\t\t\tendpoint.
You can't create non-failover resource record sets that have the same values for the\n\t\t\t\tName and Type elements as failover resource record\n\t\t\tsets.
For failover alias resource record sets, you must also include the\n\t\t\t\tEvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Route 53, see the following topics\n\t\t\tin the Amazon Route 53 Developer Guide:
\n\n Multivalue answer resource record sets only: To route traffic\n\t\t\tapproximately randomly to multiple resources, such as web servers, create one multivalue\n\t\t\tanswer record for each resource and specify true for\n\t\t\t\tMultiValueAnswer. Note the following:
If you associate a health check with a multivalue answer resource record set,\n\t\t\t\t\tAmazon Route 53 responds to DNS queries with the corresponding IP address only\n\t\t\t\t\twhen the health check is healthy.
\nIf you don't associate a health check with a multivalue answer record, Route\n\t\t\t\t\t53 always considers the record to be healthy.
\nRoute 53 responds to DNS queries with up to eight healthy records; if you have\n\t\t\t\t\teight or fewer healthy records, Route 53 responds to all DNS queries with all\n\t\t\t\t\tthe healthy records.
\nIf you have more than eight healthy records, Route 53 responds to different\n\t\t\t\t\tDNS resolvers with different combinations of healthy records.
\nWhen all records are unhealthy, Route 53 responds to DNS queries with up to\n\t\t\t\t\teight unhealthy records.
\nIf a resource becomes unavailable after a resolver caches a response, client\n\t\t\t\t\tsoftware typically tries another of the IP addresses in the response.
\nYou can't create multivalue answer alias records.
" + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "The resource record cache time to live (TTL), in seconds. Note the following:
\nIf you're creating or updating an alias resource record set, omit\n\t\t\t\t\t\tTTL. Amazon Route 53 uses the value of TTL for the\n\t\t\t\t\talias target.
If you're associating this resource record set with a health check (if you're\n\t\t\t\t\tadding a HealthCheckId element), we recommend that you specify a\n\t\t\t\t\t\tTTL of 60 seconds or less so clients respond quickly to changes\n\t\t\t\t\tin health status.
All of the resource record sets in a group of weighted resource record sets\n\t\t\t\t\tmust have the same value for TTL.
If a group of weighted resource record sets includes one or more weighted\n\t\t\t\t\talias resource record sets for which the alias target is an ELB load balancer,\n\t\t\t\t\twe recommend that you specify a TTL of 60 seconds for all of the\n\t\t\t\t\tnon-alias weighted resource record sets that have the same name and type. Values\n\t\t\t\t\tother than 60 seconds (the TTL for load balancers) will change the effect of the\n\t\t\t\t\tvalues that you specify for Weight.
Information about the resource records to act upon.
\nIf you're creating an alias resource record set, omit\n\t\t\t\tResourceRecords.
\n Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that\n\t\t\tyou want to route traffic to.
\nIf you're creating resource records sets for a private hosted zone, note the\n\t\t\tfollowing:
\nYou can't create an alias resource record set in a private hosted zone to\n\t\t\t\t\troute traffic to a CloudFront distribution.
\nFor information about creating failover resource record sets in a private\n\t\t\t\t\thosted zone, see Configuring Failover in a Private Hosted Zone in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you want Amazon Route 53 to return this resource record set in response to a DNS\n\t\t\tquery only when the status of a health check is healthy, include the\n\t\t\t\tHealthCheckId element and specify the ID of the applicable health\n\t\t\tcheck.
Route 53 determines whether a resource record set is healthy based on one of the\n\t\t\tfollowing:
\nBy periodically sending a request to the endpoint that is specified in the\n\t\t\t\t\thealth check
\nBy aggregating the status of a specified group of health checks (calculated\n\t\t\t\t\thealth checks)
\nBy determining the current state of a CloudWatch alarm (CloudWatch metric\n\t\t\t\t\thealth checks)
\nRoute 53 doesn't check the health of the endpoint that is specified in the\n\t\t\t\tresource record set, for example, the endpoint specified by the IP address in the\n\t\t\t\t\tValue element. When you add a HealthCheckId element to\n\t\t\t\ta resource record set, Route 53 checks the health of the endpoint that you specified\n\t\t\t\tin the health check.
For more information, see the following topics in the Amazon Route 53\n\t\t\t\tDeveloper Guide:
\n\n How Amazon Route 53 Determines Whether an Endpoint Is\n\t\t\t\t\tHealthy\n
\n\n When to Specify HealthCheckId\n
\nSpecifying a value for HealthCheckId is useful only when Route 53 is\n\t\t\tchoosing between two or more resource record sets to respond to a DNS query, and you\n\t\t\twant Route 53 to base the choice in part on the status of a health check. Configuring\n\t\t\thealth checks makes sense only in the following configurations:
\n Non-alias resource record sets: You're\n\t\t\t\t\tchecking the health of a group of non-alias resource record sets that have the\n\t\t\t\t\tsame routing policy, name, and type (such as multiple weighted records named\n\t\t\t\t\twww.example.com with a type of A) and you specify health check IDs for all the\n\t\t\t\t\tresource record sets.
\nIf the health check status for a resource record set is healthy, Route 53\n\t\t\t\t\tincludes the record among the records that it responds to DNS queries\n\t\t\t\t\twith.
\nIf the health check status for a resource record set is unhealthy, Route 53\n\t\t\t\t\tstops responding to DNS queries using the value for that resource record\n\t\t\t\t\tset.
\nIf the health check status for all resource record sets in the group is\n\t\t\t\t\tunhealthy, Route 53 considers all resource record sets in the group healthy and\n\t\t\t\t\tresponds to DNS queries accordingly.
\n\n Alias resource record sets: You specify the\n\t\t\t\t\tfollowing settings:
\nYou set EvaluateTargetHealth to true for an alias\n\t\t\t\t\t\t\tresource record set in a group of resource record sets that have the\n\t\t\t\t\t\t\tsame routing policy, name, and type (such as multiple weighted records\n\t\t\t\t\t\t\tnamed www.example.com with a type of A).
You configure the alias resource record set to route traffic to a\n\t\t\t\t\t\t\tnon-alias resource record set in the same hosted zone.
\nYou specify a health check ID for the non-alias resource record set.\n\t\t\t\t\t\t
\nIf the health check status is healthy, Route 53 considers the alias resource\n\t\t\t\t\trecord set to be healthy and includes the alias record among the records that it\n\t\t\t\t\tresponds to DNS queries with.
\nIf the health check status is unhealthy, Route 53 stops responding to DNS\n\t\t\t\t\tqueries using the alias resource record set.
\nThe alias resource record set can also route traffic to a\n\t\t\t\t\t\t\tgroup of non-alias resource record sets that have\n\t\t\t\t\t\tthe same routing policy, name, and type. In that configuration, associate\n\t\t\t\t\t\thealth checks with all of the resource record sets in the group of non-alias\n\t\t\t\t\t\tresource record sets.
\n\n Geolocation Routing\n
\nFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for\n\t\t\ta resource record set for the larger, associated geographic region. For example, suppose\n\t\t\tyou have resource record sets for a state in the United States, for the entire United\n\t\t\tStates, for North America, and a resource record set that has * for\n\t\t\t\tCountryCode is *, which applies to all locations. If the\n\t\t\tendpoint for the state resource record set is unhealthy, Route 53 checks for healthy\n\t\t\tresource record sets in the following order until it finds a resource record set for\n\t\t\twhich the endpoint is healthy:
The United States
\nNorth America
\nThe default resource record set
\n\n Specifying the Health Check Endpoint by Domain\n\t\t\tName\n
\nIf your health checks specify the endpoint only by domain name, we recommend that you\n\t\t\tcreate a separate health check for each endpoint. For example, create a health check for\n\t\t\teach HTTP server that is serving content for www.example.com.\n\t\t\tFor the value of FullyQualifiedDomainName, specify the domain name of the\n\t\t\tserver (such as us-east-2-www.example.com), not the name of the resource\n\t\t\trecord sets (www.example.com).
Health check results will be unpredictable if you do the following:
\nCreate a health check that has the same value for\n\t\t\t\t\t\t\tFullyQualifiedDomainName as the name of a resource record\n\t\t\t\t\t\tset.
Associate that health check with the resource record set.
\nWhen you create a traffic policy instance, Amazon Route 53 automatically creates a\n\t\t\tresource record set. TrafficPolicyInstanceId is the ID of the traffic\n\t\t\tpolicy instance that Route 53 created this resource record set for.
To delete the resource record set that is associated with a traffic policy\n\t\t\t\tinstance, use DeleteTrafficPolicyInstance. Route 53 will delete the\n\t\t\t\tresource record set automatically. If you delete the resource record set by using\n\t\t\t\t\tChangeResourceRecordSets, Route 53 doesn't automatically delete the\n\t\t\t\ttraffic policy instance, and you'll continue to be charged for it even though it's\n\t\t\t\tno longer in use.
Information about the resource record set to create or delete.
" + } + }, + "com.amazonaws.route53#ResourceRecordSetFailover": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "SECONDARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDARY" + } + } + } + }, + "com.amazonaws.route53#ResourceRecordSetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.route53#ResourceRecordSetMultiValueAnswer": { + "type": "boolean" + }, + "com.amazonaws.route53#ResourceRecordSetRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "cn_northwest_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } + }, + "ca_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-west-1" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#ResourceRecordSetWeight": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ResourceRecordSets": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceRecordSet", + "traits": { + "smithy.api#xmlName": "ResourceRecordSet" + } + } + }, + "com.amazonaws.route53#ResourceRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceRecord", + "traits": { + "smithy.api#xmlName": "ResourceRecord" + } + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.route53#ResourceTagSet": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.route53#TagResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource.
\nThe resource type for health checks is healthcheck.
The resource type for hosted zones is hostedzone.
The ID for the specified resource.
" + } + }, + "Tags": { + "target": "com.amazonaws.route53#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with the specified resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type containing a resource and its associated tags.
" + } + }, + "com.amazonaws.route53#ResourceTagSetList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#ResourceTagSet", + "traits": { + "smithy.api#xmlName": "ResourceTagSet" + } + } + }, + "com.amazonaws.route53#ResourceURI": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#ReusableDelegationSetLimit": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.route53#ReusableDelegationSetLimitType", + "traits": { + "smithy.api#documentation": "The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the\n\t\t\tmaximum number of hosted zones that you can associate with the specified reusable\n\t\t\tdelegation set.
The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET\n\t\t\tlimit.
A complex type that contains the type of limit that you specified in the request and\n\t\t\tthe current value for that limit.
" + } + }, + "com.amazonaws.route53#ReusableDelegationSetLimitType": { + "type": "enum", + "members": { + "MAX_ZONES_BY_REUSABLE_DELEGATION_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX_ZONES_BY_REUSABLE_DELEGATION_SET" + } + } + } + }, + "com.amazonaws.route53#RoutingControlArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.route53#SearchString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.route53#ServeSignature": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.route53#ServicePrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#SigningKeyInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.route53#SigningKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + } + } + }, + "com.amazonaws.route53#SigningKeyStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 150 + } + } + }, + "com.amazonaws.route53#SigningKeyStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#SigningKeyString": { + "type": "string" + }, + "com.amazonaws.route53#SigningKeyTag": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.route53#Statistic": { + "type": "enum", + "members": { + "Average": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Average" + } + }, + "Sum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Sum" + } + }, + "SampleCount": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SampleCount" + } + }, + "Maximum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Maximum" + } + }, + "Minimum": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Minimum" + } + } + } + }, + "com.amazonaws.route53#Status": { + "type": "string" + }, + "com.amazonaws.route53#StatusReport": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.route53#Status", + "traits": { + "smithy.api#documentation": "A description of the status of the health check endpoint as reported by one of the\n\t\t\tAmazon Route 53 health checkers.
" + } + }, + "CheckedTime": { + "target": "com.amazonaws.route53#TimeStamp", + "traits": { + "smithy.api#documentation": "The date and time that the health checker performed the health check in ISO 8601 format and Coordinated\n\t\t\tUniversal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z\n\t\t\trepresents March 27, 2017 at 17:48:16.751 UTC.
A complex type that contains the status that one Amazon Route 53 health checker\n\t\t\treports and the time of the health check.
" + } + }, + "com.amazonaws.route53#SubnetMask": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.route53#TTL": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2147483647 + } + } + }, + "com.amazonaws.route53#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.route53#TagKey", + "traits": { + "smithy.api#documentation": "The value of Key depends on the operation that you want to\n\t\t\tperform:
\n Add a tag to a health check or hosted zone:\n\t\t\t\t\t\tKey is the name that you want to give the new tag.
\n Edit a tag: Key is the name of\n\t\t\t\t\tthe tag that you want to change the Value for.
\n Delete a key: Key is the name\n\t\t\t\t\tof the tag you want to remove.
\n Give a name to a health check: Edit the\n\t\t\t\t\tdefault Name tag. In the Amazon Route 53 console, the list of your\n\t\t\t\t\thealth checks includes a Name column that lets\n\t\t\t\t\tyou see the name that you've given to each health check.
The value of Value depends on the operation that you want to\n\t\t\tperform:
\n Add a tag to a health check or hosted zone:\n\t\t\t\t\t\tValue is the value that you want to give the new tag.
\n Edit a tag: Value is the new\n\t\t\t\t\tvalue that you want to assign the tag.
A complex type that contains information about a tag that you want to add or edit for\n\t\t\tthe specified health check or hosted zone.
" + } + }, + "com.amazonaws.route53#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.route53#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TagKey", + "traits": { + "smithy.api#xmlName": "Key" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + } + } + }, + "com.amazonaws.route53#TagResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TagResourceId", + "traits": { + "smithy.api#xmlName": "ResourceId" + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.route53#TagResourceType": { + "type": "enum", + "members": { + "healthcheck": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "healthcheck" + } + }, + "hostedzone": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hostedzone" + } + } + } + }, + "com.amazonaws.route53#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.route53#TestDNSAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#TestDNSAnswerRequest" + }, + "output": { + "target": "com.amazonaws.route53#TestDNSAnswerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHostedZone" + } + ], + "traits": { + "smithy.api#documentation": "Gets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.
\nThis call only supports querying public hosted zones.
\nThe TestDnsAnswer returns information similar to what you would expect from the answer\n\t\t\tsection of the dig command. Therefore, if you query for the name\n\t\t\tservers of a subdomain that point to the parent name servers, those will not be\n\t\t\treturned.
The ID of the hosted zone that you want Amazon Route 53 to simulate a query\n\t\t\tfor.
", + "smithy.api#httpQuery": "hostedzoneid", + "smithy.api#required": {} + } + }, + "RecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "The name of the resource record set that you want Amazon Route 53 to simulate a query\n\t\t\tfor.
", + "smithy.api#httpQuery": "recordname", + "smithy.api#required": {} + } + }, + "RecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "The type of the resource record set.
", + "smithy.api#httpQuery": "recordtype", + "smithy.api#required": {} + } + }, + "ResolverIP": { + "target": "com.amazonaws.route53#IPAddress", + "traits": { + "smithy.api#documentation": "If you want to simulate a request from a specific DNS resolver, specify the IP address\n\t\t\tfor that resolver. If you omit this value, TestDnsAnswer uses the IP\n\t\t\taddress of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region\n\t\t\t\t(us-east-1).
If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or\n\t\t\tIPv6 address of a client in the applicable location, for example,\n\t\t\t\t192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.
If you specify an IP address for edns0clientsubnetip, you can optionally\n\t\t\tspecify the number of bits of the IP address that you want the checking tool to include\n\t\t\tin the DNS query. For example, if you specify 192.0.2.44 for\n\t\t\t\tedns0clientsubnetip and 24 for\n\t\t\t\tedns0clientsubnetmask, the checking tool will simulate a request from\n\t\t\t192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6\n\t\t\taddresses.
The range of valid values depends on whether edns0clientsubnetip is an\n\t\t\tIPv4 or an IPv6 address:
\n IPv4: Specify a value between 0 and 32
\n\n IPv6: Specify a value between 0 and\n\t\t\t\t\t128
\nGets the value that Amazon Route 53 returns in response to a DNS request for a\n\t\t\tspecified record name and type. You can optionally specify the IP address of a DNS\n\t\t\tresolver, an EDNS0 client subnet IP address, and a subnet mask.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#TestDNSAnswerResponse": { + "type": "structure", + "members": { + "Nameserver": { + "target": "com.amazonaws.route53#Nameserver", + "traits": { + "smithy.api#documentation": "The Amazon Route 53 name server used to respond to the request.
", + "smithy.api#required": {} + } + }, + "RecordName": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "The name of the resource record set that you submitted a request for.
", + "smithy.api#required": {} + } + }, + "RecordType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "The type of the resource record set that you submitted a request for.
", + "smithy.api#required": {} + } + }, + "RecordData": { + "target": "com.amazonaws.route53#RecordData", + "traits": { + "smithy.api#documentation": "A list that contains values that Amazon Route 53 returned for this resource record\n\t\t\tset.
", + "smithy.api#required": {} + } + }, + "ResponseCode": { + "target": "com.amazonaws.route53#DNSRCode", + "traits": { + "smithy.api#documentation": "A code that indicates whether the request is valid or not. The most common response\n\t\t\tcode is NOERROR, meaning that the request is valid. If the response is not\n\t\t\tvalid, Amazon Route 53 returns a response code that describes the error. For a list of\n\t\t\tpossible response codes, see DNS RCODES on the IANA website.
The protocol that Amazon Route 53 used to respond to the request, either\n\t\t\t\tUDP or TCP.
A complex type that contains the response to a TestDNSAnswer request.\n\t\t
The limit on the number of requests per second was exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.route53#TooManyHealthChecks": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "This health check can't be created because the current account has reached the limit\n\t\t\ton the number of active health checks.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nFor information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.
\nYou have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support\n\t\t\tCenter.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#TooManyHostedZones": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "This operation can't be completed either because the current account has reached the\n\t\t\tlimit on the number of hosted zones or because you've reached the limit on the number of\n\t\t\thosted zones that can be associated with a reusable delegation set.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nTo get the current limit on hosted zones that can be created by an account, see GetAccountLimit.
\nTo get the current limit on hosted zones that can be associated with a reusable\n\t\t\tdelegation set, see GetReusableDelegationSetLimit.
\nTo request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyKeySigningKeys": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You've reached the limit for the number of key-signing keys (KSKs). Remove at least\n\t\t\tone KSK, and then try again.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.route53#TooManyTrafficPolicies": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "This traffic policy can't be created because the current account has reached the limit\n\t\t\ton the number of traffic policies.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nTo get the current limit for an account, see GetAccountLimit.
\nTo request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyTrafficPolicyInstances": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "This traffic policy instance can't be created because the current account has reached\n\t\t\tthe limit on the number of traffic policy instances.
\nFor information about default limits, see Limits in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nFor information about how to get the current limit for an account, see GetAccountLimit.
\nTo request a higher limit, create a\n\t\t\t\tcase with the Amazon Web Services Support Center.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyTrafficPolicyVersionsForCurrentPolicy": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "This traffic policy version can't be created because you've reached the limit of 1000\n\t\t\ton the number of versions that you can create for the current traffic policy.
\nTo create more traffic policy versions, you can use GetTrafficPolicy\n\t\t\tto get the traffic policy document for a specified traffic policy version, and then use\n\t\t\t\tCreateTrafficPolicy to create a new traffic policy using the traffic policy\n\t\t\tdocument.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TooManyVPCAssociationAuthorizations": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "You've created the maximum number of authorizations that can be created for the\n\t\t\tspecified hosted zone. To authorize another VPC to be associated with the hosted zone,\n\t\t\tsubmit a DeleteVPCAssociationAuthorization request to remove an existing\n\t\t\tauthorization. To get a list of existing authorizations, submit a\n\t\t\t\tListVPCAssociationAuthorizations request.
The ID that Amazon Route 53 assigned to a traffic policy when you created it.
", + "smithy.api#required": {} + } + }, + "Version": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic\n\t\t\tpolicy, the value of Version is always 1.
The name that you specified when you created the traffic policy.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.
", + "smithy.api#required": {} + } + }, + "Document": { + "target": "com.amazonaws.route53#TrafficPolicyDocument", + "traits": { + "smithy.api#documentation": "The definition of a traffic policy in JSON format. You specify the JSON document to\n\t\t\tuse for a new traffic policy in the CreateTrafficPolicy request. For more\n\t\t\tinformation about the JSON format, see Traffic Policy Document Format.
The comment that you specify in the CreateTrafficPolicy request, if\n\t\t\tany.
A complex type that contains settings for a traffic policy.
" + } + }, + "com.amazonaws.route53#TrafficPolicyAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "A traffic policy that has the same value for Name already exists.
One or more traffic policy instances were created by using the specified traffic\n\t\t\tpolicy.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.route53#TrafficPolicyInstance": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceId", + "traits": { + "smithy.api#documentation": "The ID that Amazon Route 53 assigned to the new traffic policy instance.
", + "smithy.api#required": {} + } + }, + "HostedZoneId": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the hosted zone that Amazon Route 53 created resource record sets in.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#DNSName", + "traits": { + "smithy.api#documentation": "The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries\n\t\t\tby using the resource record sets that are associated with this traffic policy instance.\n\t\t
", + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "The TTL that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated in the specified hosted zone.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.route53#TrafficPolicyInstanceState", + "traits": { + "smithy.api#documentation": "The value of State is one of the following values:
Amazon Route 53 has finished creating resource record sets, and changes\n\t\t\t\t\t\thave propagated to all Route 53 edge locations.
\nRoute 53 is creating the resource record sets. Use\n\t\t\t\t\t\t\tGetTrafficPolicyInstance to confirm that the\n\t\t\t\t\t\t\tCreateTrafficPolicyInstance request completed\n\t\t\t\t\t\tsuccessfully.
Route 53 wasn't able to create or update the resource record sets. When\n\t\t\t\t\t\tthe value of State is Failed, see\n\t\t\t\t\t\t\tMessage for an explanation of what caused the request to\n\t\t\t\t\t\tfail.
If State is Failed, an explanation of the reason for the\n\t\t\tfailure. If State is another value, Message is empty.
The ID of the traffic policy that Amazon Route 53 used to create resource record sets\n\t\t\tin the specified hosted zone.
", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version of the traffic policy that Amazon Route 53 used to create resource record\n\t\t\tsets in the specified hosted zone.
", + "smithy.api#required": {} + } + }, + "TrafficPolicyType": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "The DNS type that Amazon Route 53 assigned to all of the resource record sets that it\n\t\t\tcreated for this traffic policy instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the new traffic policy instance.
" + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceAlreadyExists": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "There is already a traffic policy instance with the specified ID.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceCount": { + "type": "integer" + }, + "com.amazonaws.route53#TrafficPolicyInstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.route53#TrafficPolicyInstanceState": { + "type": "string" + }, + "com.amazonaws.route53#TrafficPolicyInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#xmlName": "TrafficPolicyInstance" + } + } + }, + "com.amazonaws.route53#TrafficPolicyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.route53#TrafficPolicySummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#TrafficPolicySummary", + "traits": { + "smithy.api#xmlName": "TrafficPolicySummary" + } + } + }, + "com.amazonaws.route53#TrafficPolicySummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "The ID that Amazon Route 53 assigned to the traffic policy when you created it.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.route53#TrafficPolicyName", + "traits": { + "smithy.api#documentation": "The name that you specified for the traffic policy when you created it.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.route53#RRType", + "traits": { + "smithy.api#documentation": "The DNS type of the resource record sets that Amazon Route 53 creates when you use a\n\t\t\ttraffic policy to create a traffic policy instance.
", + "smithy.api#required": {} + } + }, + "LatestVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version number of the latest version of the traffic policy.
", + "smithy.api#required": {} + } + }, + "TrafficPolicyCount": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The number of traffic policies that are associated with the current Amazon Web Services account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the latest version of one traffic\n\t\t\tpolicy that is associated with the current Amazon Web Services account.
" + } + }, + "com.amazonaws.route53#TrafficPolicyVersion": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.route53#TrafficPolicyVersionMarker": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.route53#TransportProtocol": { + "type": "string" + }, + "com.amazonaws.route53#UUID": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$" + } + }, + "com.amazonaws.route53#UpdateHealthCheck": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateHealthCheckRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateHealthCheckResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#HealthCheckVersionMismatch" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchHealthCheck" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing health check. Note that some values can't be updated.
\nFor more information about updating health checks, see Creating,\n\t\t\t\tUpdating, and Deleting Health Checks in the Amazon Route 53\n\t\t\t\tDeveloper Guide.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateHealthCheckRequest": { + "type": "structure", + "members": { + "HealthCheckId": { + "target": "com.amazonaws.route53#HealthCheckId", + "traits": { + "smithy.api#documentation": "The ID for the health check for which you want detailed information. When you created\n\t\t\tthe health check, CreateHealthCheck returned the ID in the response, in the\n\t\t\t\tHealthCheckId element.
A sequential counter that Amazon Route 53 sets to 1 when you create a\n\t\t\thealth check and increments by 1 each time you update settings for the health\n\t\t\tcheck.
We recommend that you use GetHealthCheck or ListHealthChecks\n\t\t\tto get the current value of HealthCheckVersion for the health check that\n\t\t\tyou want to update, and that you include that value in your\n\t\t\t\tUpdateHealthCheck request. This prevents Route 53 from overwriting an\n\t\t\tintervening update:
If the value in the UpdateHealthCheck request matches the value\n\t\t\t\t\tof HealthCheckVersion in the health check, Route 53 updates the\n\t\t\t\t\thealth check with the new settings.
If the value of HealthCheckVersion in the health check is\n\t\t\t\t\tgreater, the health check was changed after you got the version number. Route 53\n\t\t\t\t\tdoes not update the health check, and it returns a\n\t\t\t\t\t\tHealthCheckVersionMismatch error.
The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform\n\t\t\thealth checks on. If you don't specify a value for IPAddress, Route 53\n\t\t\tsends a DNS request to resolve the domain name that you specify in\n\t\t\t\tFullyQualifiedDomainName at the interval that you specify in\n\t\t\t\tRequestInterval. Using an IP address that is returned by DNS, Route 53\n\t\t\tthen checks the health of the endpoint.
Use one of the following formats for the value of IPAddress:
\n IPv4 address: four values between 0 and 255,\n\t\t\t\t\tseparated by periods (.), for example, 192.0.2.44.
\n IPv6 address: eight groups of four\n\t\t\t\t\thexadecimal values, separated by colons (:), for example,\n\t\t\t\t\t\t2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten\n\t\t\t\t\tIPv6 addresses as described in RFC 5952, for example,\n\t\t\t\t\t\t2001:db8:85a3::abcd:1:2345.
If the endpoint is an EC2 instance, we recommend that you create an Elastic IP\n\t\t\taddress, associate it with your EC2 instance, and specify the Elastic IP address for\n\t\t\t\tIPAddress. This ensures that the IP address of your instance never\n\t\t\tchanges. For more information, see the applicable documentation:
Linux: Elastic IP\n\t\t\t\t\t\tAddresses (EIP) in the Amazon EC2 User Guide for Linux\n\t\t\t\t\t\tInstances\n
\nWindows: Elastic IP\n\t\t\t\t\t\tAddresses (EIP) in the Amazon EC2 User Guide for Windows\n\t\t\t\t\t\tInstances\n
\nIf a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.
For more information, see FullyQualifiedDomainName.
\nConstraints: Route 53 can't check the health of endpoints for which the IP address is\n\t\t\tin local, private, non-routable, or multicast ranges. For more information about IP\n\t\t\taddresses for which you can't create health checks, see the following documents:
\n\n RFC 6598, IANA-Reserved IPv4\n\t\t\t\t\t\tPrefix for Shared Address Space\n
\nThe port on the endpoint that you want Amazon Route 53 to perform health checks\n\t\t\ton.
\nDon't specify a value for Port when you specify a value for\n\t\t\t\t\tType of CLOUDWATCH_METRIC or\n\t\t\t\tCALCULATED.
The path that you want Amazon Route 53 to request when performing health checks. The\n\t\t\tpath can be any value for which your endpoint will return an HTTP status code of 2xx or\n\t\t\t3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.\n\t\t\tYou can also include query string parameters, for example,\n\t\t\t\t/welcome.html?language=jp&login=y.
Specify this value only if you want to change it.
" + } + }, + "FullyQualifiedDomainName": { + "target": "com.amazonaws.route53#FullyQualifiedDomainName", + "traits": { + "smithy.api#documentation": "Amazon Route 53 behavior depends on whether you specify a value for\n\t\t\t\tIPAddress.
If a health check already has a value for IPAddress, you can change\n\t\t\t\tthe value. However, you can't update an existing health check to add or remove the\n\t\t\t\tvalue of IPAddress.
\n If you specify a value for\n IPAddress:
Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes\n\t\t\tthe value of FullyQualifiedDomainName in the Host header for\n\t\t\tall health checks except TCP health checks. This is typically the fully qualified DNS\n\t\t\tname of the endpoint on which you want Route 53 to perform health checks.
When Route 53 checks the health of an endpoint, here is how it constructs the\n\t\t\t\tHost header:
If you specify a value of 80 for Port and\n\t\t\t\t\t\tHTTP or HTTP_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify a value of 443 for Port and\n\t\t\t\t\t\tHTTPS or HTTPS_STR_MATCH for Type,\n\t\t\t\t\tRoute 53 passes the value of FullyQualifiedDomainName to the\n\t\t\t\t\tendpoint in the Host header.
If you specify another value for Port and any value except\n\t\t\t\t\t\tTCP for Type, Route 53 passes\n\t\t\t\t\t\t\t\n FullyQualifiedDomainName:Port\n \n\t\t\t\t\tto the endpoint in the Host header.
If you don't specify a value for FullyQualifiedDomainName, Route 53\n\t\t\tsubstitutes the value of IPAddress in the Host header in each\n\t\t\tof the above cases.
\n If you don't specify a value for\n IPAddress:
If you don't specify a value for IPAddress, Route 53 sends a DNS request\n\t\t\tto the domain that you specify in FullyQualifiedDomainName at the interval\n\t\t\tyou specify in RequestInterval. Using an IPv4 address that is returned by\n\t\t\tDNS, Route 53 then checks the health of the endpoint.
If you don't specify a value for IPAddress, Route 53 uses only IPv4\n\t\t\t\tto send health checks to the endpoint. If there's no resource record set with a type\n\t\t\t\tof A for the name that you specify for FullyQualifiedDomainName, the\n\t\t\t\thealth check fails with a \"DNS resolution failed\" error.
If you want to check the health of weighted, latency, or failover resource record sets\n\t\t\tand you choose to specify the endpoint only by FullyQualifiedDomainName, we\n\t\t\trecommend that you create a separate health check for each endpoint. For example, create\n\t\t\ta health check for each HTTP server that is serving content for www.example.com. For the\n\t\t\tvalue of FullyQualifiedDomainName, specify the domain name of the server\n\t\t\t(such as us-east-2-www.example.com), not the name of the resource record\n\t\t\tsets (www.example.com).
In this configuration, if the value of FullyQualifiedDomainName\n\t\t\t\tmatches the name of the resource record sets and you then associate the health check\n\t\t\t\twith those resource record sets, health check results will be unpredictable.
In addition, if the value of Type is HTTP,\n\t\t\t\tHTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH,\n\t\t\tRoute 53 passes the value of FullyQualifiedDomainName in the\n\t\t\t\tHost header, as it does when you specify a value for\n\t\t\t\tIPAddress. If the value of Type is TCP, Route\n\t\t\t53 doesn't pass a Host header.
If the value of Type is HTTP_STR_MATCH or\n\t\t\t\tHTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for\n\t\t\tin the response body from the specified resource. If the string appears in the response\n\t\t\tbody, Route 53 considers the resource healthy. (You can't change the value of\n\t\t\t\tType when you update a health check.)
The number of consecutive health checks that an endpoint must pass or fail for Amazon\n\t\t\tRoute 53 to change the current status of the endpoint from unhealthy to healthy or vice\n\t\t\tversa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the\n\t\t\t\tAmazon Route 53 Developer Guide.
\nIf you don't specify a value for FailureThreshold, the default value is\n\t\t\tthree health checks.
Specify whether you want Amazon Route 53 to invert the status of a health check, for\n\t\t\texample, to consider a health check unhealthy when it otherwise would be considered\n\t\t\thealthy.
" + } + }, + "Disabled": { + "target": "com.amazonaws.route53#Disabled", + "traits": { + "smithy.api#documentation": "Stops Route 53 from performing health checks. When you disable a health check, here's\n\t\t\twhat happens:
\n\n Health checks that check the health of\n\t\t\t\t\t\tendpoints: Route 53 stops submitting requests to your\n\t\t\t\t\tapplication, server, or other resource.
\n\n Calculated health checks: Route 53 stops\n\t\t\t\t\taggregating the status of the referenced health checks.
\n\n Health checks that monitor CloudWatch alarms:\n\t\t\t\t\tRoute 53 stops monitoring the corresponding CloudWatch metrics.
\nAfter you disable a health check, Route 53 considers the status of the health check to\n\t\t\talways be healthy. If you configured DNS failover, Route 53 continues to route traffic\n\t\t\tto the corresponding resources. If you want to stop routing traffic to a resource,\n\t\t\tchange the value of Inverted.
\nCharges for a health check still apply when the health check is disabled. For more\n\t\t\tinformation, see Amazon Route 53\n\t\t\t\tPricing.
" + } + }, + "HealthThreshold": { + "target": "com.amazonaws.route53#HealthThreshold", + "traits": { + "smithy.api#documentation": "The number of child health checks that are associated with a CALCULATED\n\t\t\thealth that Amazon Route 53 must consider healthy for the CALCULATED health\n\t\t\tcheck to be considered healthy. To specify the child health checks that you want to\n\t\t\tassociate with a CALCULATED health check, use the\n\t\t\t\tChildHealthChecks and ChildHealthCheck elements.
Note the following:
\nIf you specify a number greater than the number of child health checks, Route\n\t\t\t\t\t53 always considers this health check to be unhealthy.
\nIf you specify 0, Route 53 always considers this health check to\n\t\t\t\t\tbe healthy.
A complex type that contains one ChildHealthCheck element for each health\n\t\t\tcheck that you want to associate with a CALCULATED health check.
Specify whether you want Amazon Route 53 to send the value of\n\t\t\t\tFullyQualifiedDomainName to the endpoint in the\n\t\t\t\tclient_hello message during TLS negotiation. This allows\n\t\t\tthe endpoint to respond to HTTPS health check requests with the applicable\n\t\t\tSSL/TLS certificate.
Some endpoints require that HTTPS requests include the host name in the\n\t\t\t\tclient_hello message. If you don't enable SNI, the status of the health\n\t\t\tcheck will be SSL alert handshake_failure. A health check can also have\n\t\t\tthat status for other reasons. If SNI is enabled and you're still getting the error,\n\t\t\tcheck the SSL/TLS configuration on your endpoint and confirm that your certificate is\n\t\t\tvalid.
The SSL/TLS certificate on your endpoint includes a domain name in the Common\n\t\t\t\tName field and possibly several more in the Subject Alternative\n\t\t\t\tNames field. One of the domain names in the certificate should match the\n\t\t\tvalue that you specify for FullyQualifiedDomainName. If the endpoint\n\t\t\tresponds to the client_hello message with a certificate that does not\n\t\t\tinclude the domain name that you specified in FullyQualifiedDomainName, a\n\t\t\thealth checker will retry the handshake. In the second attempt, the health checker will\n\t\t\tomit FullyQualifiedDomainName from the client_hello\n\t\t\tmessage.
A complex type that contains one Region element for each region that you\n\t\t\twant Amazon Route 53 health checkers to check the specified endpoint from.
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53\n\t\t\thealth checkers to use to determine whether the specified health check is\n\t\t\thealthy.
" + } + }, + "InsufficientDataHealthStatus": { + "target": "com.amazonaws.route53#InsufficientDataHealthStatus", + "traits": { + "smithy.api#documentation": "When CloudWatch has insufficient data about the metric to determine the alarm state,\n\t\t\tthe status that you want Amazon Route 53 to assign to the health check:
\n\n Healthy: Route 53 considers the health check to be\n\t\t\t\t\thealthy.
\n Unhealthy: Route 53 considers the health check to be\n\t\t\t\t\tunhealthy.
\n LastKnownStatus: By default, Route 53 uses the status of the\n\t\t\t\t\thealth check from the last time CloudWatch had sufficient data to determine the\n\t\t\t\t\talarm state. For new health checks that have no last known status, the status\n\t\t\t\t\tfor the health check is healthy.
A complex type that contains one ResettableElementName element for each\n\t\t\telement that you want to reset to the default value. Valid values for\n\t\t\t\tResettableElementName include the following:
\n ChildHealthChecks: Amazon Route 53 resets ChildHealthChecks to null.
\n FullyQualifiedDomainName: Route 53 resets FullyQualifiedDomainName. to null.
\n Regions: Route 53 resets the Regions list to the default set of regions.
\n ResourcePath: Route 53 resets ResourcePath to null.
A complex type that contains information about a request to update a health\n\t\t\tcheck.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateHealthCheckResponse": { + "type": "structure", + "members": { + "HealthCheck": { + "target": "com.amazonaws.route53#HealthCheck", + "traits": { + "smithy.api#documentation": "A complex type that contains the response to an UpdateHealthCheck\n\t\t\trequest.
A complex type that contains the response to the UpdateHealthCheck\n\t\t\trequest.
Updates the comment for a specified hosted zone.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/hostedzone/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateHostedZoneCommentRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#ResourceId", + "traits": { + "smithy.api#documentation": "The ID for the hosted zone that you want to update the comment for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Comment": { + "target": "com.amazonaws.route53#ResourceDescription", + "traits": { + "smithy.api#documentation": "The new comment for the hosted zone. If you don't specify a value for\n\t\t\t\tComment, Amazon Route 53 deletes the existing value of the\n\t\t\t\tComment element, if any.
A request to update the comment for a hosted zone.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateHostedZoneCommentResponse": { + "type": "structure", + "members": { + "HostedZone": { + "target": "com.amazonaws.route53#HostedZone", + "traits": { + "smithy.api#documentation": "A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.
A complex type that contains the response to the UpdateHostedZoneComment\n\t\t\trequest.
Updates the comment for a specified traffic policy version.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2013-04-01/trafficpolicy/{Id}/{Version}", + "code": 200 + } + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyCommentRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "The value of Id for the traffic policy that you want to update the\n\t\t\tcomment for.
The value of Version for the traffic policy that you want to update the\n\t\t\tcomment for.
The new comment for the specified traffic policy and version.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the traffic policy that you want to\n\t\t\tupdate the comment for.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyCommentResponse": { + "type": "structure", + "members": { + "TrafficPolicy": { + "target": "com.amazonaws.route53#TrafficPolicy", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the specified traffic policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains the response information for the traffic policy.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceRequest" + }, + "output": { + "target": "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53#ConflictingTypes" + }, + { + "target": "com.amazonaws.route53#InvalidInput" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicy" + }, + { + "target": "com.amazonaws.route53#NoSuchTrafficPolicyInstance" + }, + { + "target": "com.amazonaws.route53#PriorRequestNotComplete" + } + ], + "traits": { + "smithy.api#documentation": "After you submit a UpdateTrafficPolicyInstance request, there's a brief delay while Route 53 creates the resource record sets \n\t\t\tthat are specified in the traffic policy definition. Use GetTrafficPolicyInstance with the id of updated traffic policy instance confirm \n\t\t\tthat the \n\t\t\tUpdateTrafficPolicyInstance request completed successfully. For more information, see the State response element.
Updates the resource record sets in a specified hosted zone that were created based on\n\t\t\tthe settings in a specified traffic policy version.
\nWhen you update a traffic policy instance, Amazon Route 53 continues to respond to DNS\n\t\t\tqueries for the root resource record set name (such as example.com) while it replaces\n\t\t\tone group of resource record sets with another. Route 53 performs the following\n\t\t\toperations:
\nRoute 53 creates a new group of resource record sets based on the specified\n\t\t\t\t\ttraffic policy. This is true regardless of how significant the differences are\n\t\t\t\t\tbetween the existing resource record sets and the new resource record sets.\n\t\t\t\t
\nWhen all of the new resource record sets have been created, Route 53 starts to\n\t\t\t\t\trespond to DNS queries for the root resource record set name (such as\n\t\t\t\t\texample.com) by using the new resource record sets.
\nRoute 53 deletes the old group of resource record sets that are associated\n\t\t\t\t\twith the root resource record set name.
\nThe ID of the traffic policy instance that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TTL": { + "target": "com.amazonaws.route53#TTL", + "traits": { + "smithy.api#documentation": "The TTL that you want Amazon Route 53 to assign to all of the updated resource record\n\t\t\tsets.
", + "smithy.api#required": {} + } + }, + "TrafficPolicyId": { + "target": "com.amazonaws.route53#TrafficPolicyId", + "traits": { + "smithy.api#documentation": "The ID of the traffic policy that you want Amazon Route 53 to use to update resource\n\t\t\trecord sets for the specified traffic policy instance.
", + "smithy.api#required": {} + } + }, + "TrafficPolicyVersion": { + "target": "com.amazonaws.route53#TrafficPolicyVersion", + "traits": { + "smithy.api#documentation": "The version of the traffic policy that you want Amazon Route 53 to use to update\n\t\t\tresource record sets for the specified traffic policy instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the resource record sets that you want\n\t\t\tto update based on a specified traffic policy instance.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.route53#UpdateTrafficPolicyInstanceResponse": { + "type": "structure", + "members": { + "TrafficPolicyInstance": { + "target": "com.amazonaws.route53#TrafficPolicyInstance", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for the updated traffic policy instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains information about the resource record sets that Amazon\n\t\t\tRoute 53 created based on a specified traffic policy.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.route53#UsageCount": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.route53#VPC": { + "type": "structure", + "members": { + "VPCRegion": { + "target": "com.amazonaws.route53#VPCRegion", + "traits": { + "smithy.api#documentation": "(Private hosted zones only) The region that an Amazon VPC was created\n\t\t\tin.
" + } + }, + "VPCId": { + "target": "com.amazonaws.route53#VPCId" + } + }, + "traits": { + "smithy.api#documentation": "(Private hosted zones only) A complex type that contains information about an Amazon VPC.
\nIf you associate a private hosted zone with an Amazon VPC when you make a\n\t\t\t\tCreateHostedZone\n\t\t\trequest, the following parameters are also required.
" + } + }, + "com.amazonaws.route53#VPCAssociationAuthorizationNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "" + } + } + }, + "traits": { + "smithy.api#documentation": "The VPC that you specified is not authorized to be associated with the hosted\n\t\t\tzone.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#VPCAssociationNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.route53#ErrorMessage", + "traits": { + "smithy.api#documentation": "The specified VPC or hosted zone weren't found.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The specified VPC and hosted zone are not currently associated.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.route53#VPCId": { + "type": "string", + "traits": { + "smithy.api#documentation": "(Private hosted zones only) The ID of an Amazon VPC.
", + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.route53#VPCRegion": { + "type": "enum", + "members": { + "us_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "us_east_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "us_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "us_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "eu_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "eu_west_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "eu_west_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "eu_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "eu_central_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-2" + } + }, + "ap_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "me_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "us_gov_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "us_gov_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + }, + "us_iso_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-east-1" + } + }, + "us_iso_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-iso-west-1" + } + }, + "us_isob_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-isob-east-1" + } + }, + "me_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-central-1" + } + }, + "ap_southeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "ap_southeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "ap_southeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-3" + } + }, + "ap_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "ap_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-2" + } + }, + "ap_northeast_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "ap_northeast_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "ap_northeast_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-3" + } + }, + "eu_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "sa_east_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "ca_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "cn_north_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "af_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "eu_south_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-1" + } + }, + "eu_south_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-south-2" + } + }, + "ap_southeast_4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-4" + } + }, + "il_central_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "il-central-1" + } + }, + "ca_west_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-west-1" + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.route53#VPCs": { + "type": "list", + "member": { + "target": "com.amazonaws.route53#VPC", + "traits": { + "smithy.api#xmlName": "VPC" + } + }, + "traits": { + "smithy.api#documentation": "(Private hosted zones only) A list of VPC elements.