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#documentation": "The name of the app block.
", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "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#documentation": "The ARN of the app block builder.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "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#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#documentation": "The VPC configuration for the app block builder.
", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.appstream#AppBlockBuilderState", - "traits": { - "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#documentation": "The ARN of the app block.
", - "smithy.api#required": {} - } - }, - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "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#default": false, - "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#documentation": "The name of the fleet associated with the application.
", - "smithy.api#required": {} - } - }, - "ApplicationArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "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#default": false, - "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#default": false, - "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#documentation": "The ARN of the app block.
", - "smithy.api#required": {} - } - }, - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "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#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "ApplicationArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "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#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "EntitlementName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "ApplicationIdentifier": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The identifier of the application.
", - "smithy.api#required": {} - } - } - }, - "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#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "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#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#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", - "traits": { - "smithy.api#default": false - } - }, - "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.
", - "smithy.api#required": {} - } - } - }, - "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#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.
" - } - } - }, - "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#documentation": "The name of the image to copy.
", - "smithy.api#required": {} - } - }, - "DestinationImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "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#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#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#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#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#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#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#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#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 location in S3 of the application icon.
", - "smithy.api#required": {} - } - }, - "LaunchPath": { - "target": "com.amazonaws.appstream#String", - "traits": { - "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#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#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#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#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.
", - "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#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the entitlement.
" - } - }, - "AppVisibility": { - "target": "com.amazonaws.appstream#AppVisibility", - "traits": { - "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.appstream#EntitlementAttributeList", - "traits": { - "smithy.api#documentation": "The attributes of the entitlement.
", - "smithy.api#required": {} - } - } - }, - "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#documentation": "The name of the app block.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "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#documentation": "The ARN of the app block builder.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "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#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#documentation": "The VPC configuration for the app block builder.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.appstream#AppBlockBuilderState", + "traits": { + "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#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "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#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#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 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 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.
" - } - } - }, - "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#default": false, + "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#documentation": "The name of the fleet associated with the application.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "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#default": false, + "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#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#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#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#documentation": "The name of the stack.
", - "smithy.api#required": {} - } - }, - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.appstream#StreamingUrlUserId", - "traits": { - "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#documentation": "The name of the image to update.
", - "smithy.api#required": {} - } - }, - "newImageName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "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#default": false, - "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#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#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#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#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#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#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#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", - "smithy.api#required": {} - } - } - }, - "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#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#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#documentation": "The name of the private image.
", - "smithy.api#required": {} - } - }, - "SharedAccountId": { - "target": "com.amazonaws.appstream#AwsAccountId", - "traits": { - "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#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#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#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#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#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#String", - "traits": { - "smithy.api#documentation": "The name of the stack. This value is case-sensitive.
", - "smithy.api#required": {} - } - }, - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "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.
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#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#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#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#documentation": "The ARN of the app block.
", - "smithy.api#required": {} - } - }, - "AppBlockBuilderName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "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#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "ApplicationArn": { - "target": "com.amazonaws.appstream#Arn", - "traits": { - "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#documentation": "The name of the stack with which the entitlement is associated.
", - "smithy.api#required": {} - } - }, - "EntitlementName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "ApplicationIdentifier": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The identifier of the application to remove from the entitlement.
", - "smithy.api#required": {} - } - } - }, - "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#documentation": "The name of the fleet.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "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#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#documentation": "The identifier of the application.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The application associated to an entitlement. Access is controlled based on user attributes.
" - } - }, - "com.amazonaws.appstream#EntitledApplicationList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#EntitledApplication" - } - }, - "com.amazonaws.appstream#Entitlement": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the entitlement.
" - } - }, - "AppVisibility": { - "target": "com.amazonaws.appstream#AppVisibility", - "traits": { - "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.appstream#EntitlementAttributeList", - "traits": { - "smithy.api#documentation": "The attributes of the entitlement.
", - "smithy.api#required": {} - } - }, - "CreatedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the entitlement was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.appstream#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the entitlement was last modified.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies an entitlement. Entitlements control access to specific applications within\n a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user\n identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all\n applications in a stack. Entitlements don't apply to the desktop stream view\n application, or to applications managed by a dynamic app provider using the Dynamic\n Application Framework.
" - } - }, - "com.amazonaws.appstream#EntitlementAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The entitlement already exists.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#EntitlementAttribute": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "A supported AWS IAM SAML PrincipalTag attribute that is matched to the\n associated value when a user identity federates into an Amazon AppStream 2.0 SAML\n application.
The following are valid values:
\nroles
\ndepartment
\norganization
\ngroups
\ntitle
\ncostCenter
\nuserType
\n", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "
A value that is matched to a supported SAML attribute name when a user identity\n federates into an Amazon AppStream 2.0 SAML application.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "An attribute associated with an entitlement. Application entitlements work by matching\n a supported SAML 2.0 attribute name to a value when a user identity federates to an\n Amazon AppStream 2.0 SAML application.
" - } - }, - "com.amazonaws.appstream#EntitlementAttributeList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#EntitlementAttribute" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.appstream#EntitlementList": { - "type": "list", - "member": { - "target": "com.amazonaws.appstream#Entitlement" - } - }, - "com.amazonaws.appstream#EntitlementNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.appstream#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The entitlement can't be found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.appstream#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#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#documentation": "The Amazon Resource Name (ARN) for the fleet.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.appstream#String", - "traits": { - "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#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#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.
" - } - } - }, - "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" - } - } - }, - "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#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#default": false, - "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#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#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#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#documentation": "The name of the stack with which the entitlement is associated.
", - "smithy.api#required": {} - } - }, - "EntitlementName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.appstream#Integer", - "traits": { - "smithy.api#documentation": "The maximum size of each page of results.
" - } - } - }, - "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#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#default": false, + "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#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "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#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "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#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "EntitlementName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The identifier of the application.
", + "smithy.api#required": {} + } + } + }, + "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#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "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#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#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", + "traits": { + "smithy.api#default": false + } + }, + "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#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#documentation": "The name of the image to copy.
", + "smithy.api#required": {} + } + }, + "DestinationImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "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#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#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#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#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#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#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#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 location in S3 of the application icon.
", + "smithy.api#required": {} + } + }, + "LaunchPath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "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#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#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#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#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.
", + "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#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the entitlement.
" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "The attributes of the entitlement.
", + "smithy.api#required": {} + } + } + }, + "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#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#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#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#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#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#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.appstream#StreamingUrlUserId", + "traits": { + "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#documentation": "The name of the image to update.
", + "smithy.api#required": {} + } + }, + "newImageName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "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#default": false, + "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#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#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#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#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#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#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#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + } + }, + "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#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#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#documentation": "The name of the private image.
", + "smithy.api#required": {} + } + }, + "SharedAccountId": { + "target": "com.amazonaws.appstream#AwsAccountId", + "traits": { + "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#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#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#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#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": "ACTIVE", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "PENDING_DEACTIVATE", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "INACTIVE", + "comparator": "anyStringEquals" + } + } + } + ], + "minDelay": 30 + }, + "FleetStopped": { + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "INACTIVE", + "comparator": "allStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "PENDING_ACTIVATE", + "comparator": "anyStringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Fleets[].State", + "expected": "ACTIVE", + "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#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#documentation": "The name of the stack. This value is case-sensitive.
", + "smithy.api#required": {} + } + }, + "FleetName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "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#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#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#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#documentation": "The ARN of the app block.
", + "smithy.api#required": {} + } + }, + "AppBlockBuilderName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "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#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "ApplicationArn": { + "target": "com.amazonaws.appstream#Arn", + "traits": { + "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#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "EntitlementName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The identifier of the application to remove from the entitlement.
", + "smithy.api#required": {} + } + } + }, + "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#documentation": "The name of the fleet.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "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#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#documentation": "The identifier of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The application associated to an entitlement. Access is controlled based on user attributes.
" + } + }, + "com.amazonaws.appstream#EntitledApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#EntitledApplication" + } + }, + "com.amazonaws.appstream#Entitlement": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the entitlement.
" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "The attributes of the entitlement.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the entitlement was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the entitlement was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an entitlement. Entitlements control access to specific applications within\n a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user\n identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all\n applications in a stack. Entitlements don't apply to the desktop stream view\n application, or to applications managed by a dynamic app provider using the Dynamic\n Application Framework.
" + } + }, + "com.amazonaws.appstream#EntitlementAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The entitlement already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appstream#EntitlementAttribute": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "A supported AWS IAM SAML PrincipalTag attribute that is matched to the\n associated value when a user identity federates into an Amazon AppStream 2.0 SAML\n application.
The following are valid values:
\nroles
\ndepartment
\norganization
\ngroups
\ntitle
\ncostCenter
\nuserType
\n", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "
A value that is matched to a supported SAML attribute name when a user identity\n federates into an Amazon AppStream 2.0 SAML application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An attribute associated with an entitlement. Application entitlements work by matching\n a supported SAML 2.0 attribute name to a value when a user identity federates to an\n Amazon AppStream 2.0 SAML application.
" + } + }, + "com.amazonaws.appstream#EntitlementAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#EntitlementAttribute" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.appstream#EntitlementList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Entitlement" + } + }, + "com.amazonaws.appstream#EntitlementNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The entitlement can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appstream#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#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#documentation": "The Amazon Resource Name (ARN) for the fleet.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "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#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#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#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#default": false, + "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#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.
" + } }, - { - "target": "com.amazonaws.appstream#AssociateApplicationFleet" + "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" + } }, - { - "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#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#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#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "EntitlementName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + }, + "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#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#documentation": "The S3 object location for the script.
", + "smithy.api#required": {} + } + }, + "ExecutablePath": { + "target": "com.amazonaws.appstream#String", + "traits": { + "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#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#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#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#documentation": "The identifier of the streaming session.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.appstream#UserId", + "traits": { + "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#documentation": "The name of the stack for the streaming session.
", + "smithy.api#required": {} + } + }, + "FleetName": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The name of the fleet for the streaming session.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.appstream#SessionState", + "traits": { + "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#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#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#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#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#documentation": "The name of the fleet.
", + "smithy.api#required": {} } - ] } - ], - "type": "tree", - "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" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appstream2.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "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#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].
" } - ] } - ] }, - { - "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#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#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#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#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#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.appstream#Tags", + "traits": { + "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#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.appstream#TagKeyList", + "traits": { + "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.
" + } + } + }, + "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#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" }, - { - "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 - } + "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#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#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the entitlement.
" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "Specifies whether all or only selected apps are entitled.
" + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "The attributes of the entitlement.
" + } + } }, - { - "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#default": false, + "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" - } - }, - "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#documentation": "The S3 object location for the script.
", - "smithy.api#required": {} - } - }, - "ExecutablePath": { - "target": "com.amazonaws.appstream#String", - "traits": { - "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#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#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#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#documentation": "The identifier of the streaming session.
", - "smithy.api#required": {} - } - }, - "UserId": { - "target": "com.amazonaws.appstream#UserId", - "traits": { - "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#documentation": "The name of the stack for the streaming session.
", - "smithy.api#required": {} - } - }, - "FleetName": { - "target": "com.amazonaws.appstream#String", - "traits": { - "smithy.api#documentation": "The name of the fleet for the streaming session.
", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.appstream#SessionState", - "traits": { - "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.
" - } - } - }, - "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#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#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#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#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#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#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#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#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#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#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#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.appstream#Tags", - "traits": { - "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#documentation": "The Amazon Resource Name (ARN) of the resource.
", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.appstream#TagKeyList", - "traits": { - "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#documentation": "The name of the private image.
", + "smithy.api#required": {} + } + }, + "SharedAccountId": { + "target": "com.amazonaws.appstream#AwsAccountId", + "traits": { + "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#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#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#default": false, + "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#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#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#documentation": "The name of the entitlement.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.appstream#Name", - "traits": { - "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.appstream#Description", - "traits": { - "smithy.api#documentation": "The description of the entitlement.
" - } - }, - "AppVisibility": { - "target": "com.amazonaws.appstream#AppVisibility", - "traits": { - "smithy.api#documentation": "Specifies whether all or only selected apps are entitled.
" - } - }, - "Attributes": { - "target": "com.amazonaws.appstream#EntitlementAttributeList", - "traits": { - "smithy.api#documentation": "The attributes of the entitlement.
" - } - } - }, - "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#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#documentation": "The action that is enabled or disabled.
", + "smithy.api#required": {} + } + }, + "Permission": { + "target": "com.amazonaws.appstream#Permission", + "traits": { + "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.
" + } }, - { - "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#String", - "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#default": false, - "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.
" - } - } - }, - "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#documentation": "The name of the private image.
", - "smithy.api#required": {} - } - }, - "SharedAccountId": { - "target": "com.amazonaws.appstream#AwsAccountId", - "traits": { - "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#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#documentation": "The name of the stack that is associated with the user.
", + "smithy.api#required": {} + } + }, + "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.
", + "smithy.api#required": {} + } + }, + "SendEmailNotification": { + "target": "com.amazonaws.appstream#Boolean", + "traits": { + "smithy.api#default": false, + "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#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#default": false, - "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#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#documentation": "The action that is enabled or disabled.
", - "smithy.api#required": {} - } - }, - "Permission": { - "target": "com.amazonaws.appstream#Permission", - "traits": { - "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#documentation": "The name of the stack that is associated with the user.
", - "smithy.api#required": {} - } - }, - "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.
", - "smithy.api#required": {} - } - }, - "SendEmailNotification": { - "target": "com.amazonaws.appstream#Boolean", - "traits": { - "smithy.api#default": false, - "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.
" - } } - } -} \ No newline at end of file +} diff --git a/codegen/sdk-codegen/aws-models/cloudformation.json b/codegen/sdk-codegen/aws-models/cloudformation.json index 4569a1a74129..f5ab3ef65077 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.json @@ -1,13201 +1,13201 @@ { - "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.cloudformation#AcceptTermsAndConditions": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#Account": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.cloudformation#AccountFilterType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "INTERSECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERSECTION" - } - }, - "DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFFERENCE" - } - }, - "UNION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNION" - } - } - } - }, - "com.amazonaws.cloudformation#AccountGateResult": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.cloudformation#AccountGateStatus", - "traits": { - "smithy.api#documentation": "The status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account and Region passes any\n requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that\n account and Region.
\n FAILED: The account gate function has determined that the account and Region doesn't meet the\n requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account\n and Region, and sets the stack set operation result status for that account and Region to\n FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate function for this account and\n Region, for one of the following reasons:
An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with\n the stack set operation in this account and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set administration account lacks\n permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account\n and Region.
Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack\n set operation in this account and Region.
\nThe reason for the account gate status assigned to this account and Region for the stack set operation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation invokes, if present,\n before proceeding with a stack set operation in an account and Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda function that encapsulates\n any requirements that must be met before CloudFormation can proceed with a stack set operation in that\n account and Region. CloudFormation invokes the function each time a stack set operation is requested for\n that account and Region; if the function returns FAILED, CloudFormation cancels the operation\n in that account and Region, and sets the stack set operation result status for that account and Region to\n FAILED.
For more information, see Configuring a target account\n gate.
" - } - }, - "com.amazonaws.cloudformation#AccountGateStatus": { - "type": "enum", - "members": { - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - } - } - }, - "com.amazonaws.cloudformation#AccountGateStatusReason": { - "type": "string" - }, - "com.amazonaws.cloudformation#AccountLimit": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudformation#LimitName", - "traits": { - "smithy.api#documentation": "The name of the account limit.
\nValues: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit\n
The value that's associated with the account limit name.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see CloudFormation\n quotas in the CloudFormation User Guide.
" - } - }, - "com.amazonaws.cloudformation#AccountLimitList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#AccountLimit" - } - }, - "com.amazonaws.cloudformation#AccountList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Account" - } - }, - "com.amazonaws.cloudformation#AccountsUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5120 - }, - "smithy.api#pattern": "^(s3://|http(s?)://).+$" - } - }, - "com.amazonaws.cloudformation#ActivateOrganizationsAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ActivateOrganizationsAccessOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets\n and Organizations activated, the management account has permissions to create\n and manage StackSets for your organization.
" - } - }, - "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ActivateOrganizationsAccessOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ActivateType": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ActivateTypeInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ActivateTypeOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - }, - { - "target": "com.amazonaws.cloudformation#TypeNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see\n Configuring extensions at\n the account level in the CloudFormation User Guide.
", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#ActivateTypeInput": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#ThirdPartyType", - "traits": { - "smithy.api#documentation": "The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" - } - }, - "AutoUpdate": { - "target": "com.amazonaws.cloudformation#AutoUpdate", - "traits": { - "smithy.api#documentation": "Whether to automatically update the extension in this account and Region when a new minor\n version is published by the extension publisher. Major versions released by the publisher must be manually\n updated.
\nThe default is true.
Contains logging configuration information for an extension.
" - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.cloudformation#RoleARN2", - "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to activate the extension.
" - } - }, - "VersionBump": { - "target": "com.amazonaws.cloudformation#VersionBump", - "traits": { - "smithy.api#documentation": "Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is\n available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is\n available.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of\n the major version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
The Amazon Resource Name (ARN) of the activated extension, in this account and Region.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#AllowedValue": { - "type": "string" - }, - "com.amazonaws.cloudformation#AllowedValues": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#AllowedValue" - } - }, - "com.amazonaws.cloudformation#AlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "AlreadyExistsException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The resource with the name requested already exists.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#Arn": { - "type": "string" - }, - "com.amazonaws.cloudformation#AutoDeployment": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.cloudformation#AutoDeploymentNullable", - "traits": { - "smithy.api#documentation": "If set to true, StackSets automatically deploys additional stack instances to Organizations\n accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account\n is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified\n Regions.
If set to true, stack resources are retained when an account is removed from a target organization\n or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to\n True.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" - } - }, - "com.amazonaws.cloudformation#AutoDeploymentNullable": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#AutoUpdate": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#BatchDescribeTypeConfigurations": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - }, - { - "target": "com.amazonaws.cloudformation#TypeConfigurationNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" - } - }, - "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { - "type": "structure", - "members": { - "ErrorCode": { - "target": "com.amazonaws.cloudformation#ErrorCode", - "traits": { - "smithy.api#documentation": "The error code.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.cloudformation#ErrorMessage", - "traits": { - "smithy.api#documentation": "The error message.
" - } - }, - "TypeConfigurationIdentifier": { - "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier", - "traits": { - "smithy.api#documentation": "Identifying information for the configuration of a CloudFormation extension.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
" - } - }, - "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError" - } - }, - "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput": { - "type": "structure", - "members": { - "TypeConfigurationIdentifiers": { - "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifiers", - "traits": { - "smithy.api#documentation": "The list of identifiers for the desired extension configurations.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput": { - "type": "structure", - "members": { - "Errors": { - "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors", - "traits": { - "smithy.api#documentation": "A list of information concerning any errors generated during the setting of the specified configurations.
" - } - }, - "UnprocessedTypeConfigurations": { - "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", - "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any\n reason.
" - } - }, - "TypeConfigurations": { - "target": "com.amazonaws.cloudformation#TypeConfigurationDetailsList", - "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations from the CloudFormation registry.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#BoxedInteger": { - "type": "integer" - }, - "com.amazonaws.cloudformation#BoxedMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.cloudformation#CFNRegistryException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage", - "traits": { - "smithy.api#documentation": "An message with details about the error that occurred.
" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CFNRegistryException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "An error occurred during a CloudFormation registry operation.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#CallAs": { - "type": "enum", - "members": { - "SELF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELF" - } - }, - "DELEGATED_ADMIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELEGATED_ADMIN" - } - } - } - }, - "com.amazonaws.cloudformation#CancelUpdateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#CancelUpdateStackInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update\n and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
If you don't pass a parameter to StackName, the API returns a response that describes\n all resources in the account.
The IAM policy below can be added to\n IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\":\n \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", - "smithy.api#required": {} - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same\n name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received\n them.
The input for the CancelUpdateStack action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#Capabilities": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Capability" - } - }, - "com.amazonaws.cloudformation#CapabilitiesReason": { - "type": "string" - }, - "com.amazonaws.cloudformation#Capability": { - "type": "enum", - "members": { - "CAPABILITY_IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAPABILITY_IAM" - } - }, - "CAPABILITY_NAMED_IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAPABILITY_NAMED_IAM" - } - }, - "CAPABILITY_AUTO_EXPAND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CAPABILITY_AUTO_EXPAND" - } - } - } - }, - "com.amazonaws.cloudformation#Category": { - "type": "enum", - "members": { - "REGISTERED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REGISTERED" - } - }, - "ACTIVATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVATED" - } - }, - "THIRD_PARTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIRD_PARTY" - } - }, - "AWS_TYPES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_TYPES" - } - } - } - }, - "com.amazonaws.cloudformation#CausingEntity": { - "type": "string" - }, - "com.amazonaws.cloudformation#Change": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#ChangeType", - "traits": { - "smithy.api#documentation": "The type of entity that CloudFormation changes. Currently, the only entity type is\n Resource.
Is either null, if no hooks invoke for the resource, or contains the number of hooks that will\n invoke for the resource.
A ResourceChange structure that describes the resource and action that CloudFormation will\n perform.
The Change structure describes the changes CloudFormation will perform if you execute the\n change set.
Specifies the points in provisioning logic where a hook is invoked.
" - } - }, - "FailureMode": { - "target": "com.amazonaws.cloudformation#HookFailureMode", - "traits": { - "smithy.api#documentation": "Specify the hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The version ID of the type specified.
" - } - }, - "TypeConfigurationVersionId": { - "target": "com.amazonaws.cloudformation#HookTypeConfigurationVersionId", - "traits": { - "smithy.api#documentation": "The version ID of the type configuration.
" - } - }, - "TargetDetails": { - "target": "com.amazonaws.cloudformation#ChangeSetHookTargetDetails", - "traits": { - "smithy.api#documentation": "Specifies details about the target that the hook will run against.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the resource, the hook, and the hook version to be invoked.
" - } - }, - "com.amazonaws.cloudformation#ChangeSetHookResourceTargetDetails": { - "type": "structure", - "members": { - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The resource's logical ID, which is defined in the stack's template.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#HookTargetTypeName", - "traits": { - "smithy.api#documentation": "The type of CloudFormation resource, such as AWS::S3::Bucket.
Specifies the action of the resource.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies RESOURCE type target details for activated hooks.
The name of the type.
" - } - }, - "ResourceTargetDetails": { - "target": "com.amazonaws.cloudformation#ChangeSetHookResourceTargetDetails", - "traits": { - "smithy.api#documentation": "Required if TargetType is RESOURCE.
Specifies target details for an activated hook.
" - } - }, - "com.amazonaws.cloudformation#ChangeSetHooks": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#ChangeSetHook" - } - }, - "com.amazonaws.cloudformation#ChangeSetHooksStatus": { - "type": "enum", - "members": { - "PLANNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLANNING" - } - }, - "PLANNED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLANNED" - } - }, - "UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNAVAILABLE" - } - } - } - }, - "com.amazonaws.cloudformation#ChangeSetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^arn:[-a-zA-Z0-9:/]*$" - } - }, - "com.amazonaws.cloudformation#ChangeSetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" - } - }, - "com.amazonaws.cloudformation#ChangeSetNameOrId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1600 - }, - "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*$" - } - }, - "com.amazonaws.cloudformation#ChangeSetNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ChangeSetNotFound", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the\n ListChangeSets operation.
The ID of the stack with which the change set is associated.
" - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name of the stack with which the change set is associated.
" - } - }, - "ChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", - "traits": { - "smithy.api#documentation": "The ID of the change set.
" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetName", - "traits": { - "smithy.api#documentation": "The name of the change set.
" - } - }, - "ExecutionStatus": { - "target": "com.amazonaws.cloudformation#ExecutionStatus", - "traits": { - "smithy.api#documentation": "If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.
The start time when the change set was created, in UTC.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "Descriptive information about the change set.
" - } - }, - "IncludeNestedStacks": { - "target": "com.amazonaws.cloudformation#IncludeNestedStacks", - "traits": { - "smithy.api#documentation": "Specifies the current setting of IncludeNestedStacks for the change set.
The parent change set ID.
" - } - }, - "RootChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", - "traits": { - "smithy.api#documentation": "The root change set ID.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The ChangeSetSummary structure describes a change set, its status, and the stack with which it's\n associated.
The status of the account gate function.
\n\n SUCCEEDED: The account gate function has determined that the account and Region passes any\n requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that\n account and Region.
\n FAILED: The account gate function has determined that the account and Region doesn't meet the\n requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account\n and Region, and sets the stack set operation result status for that account and Region to\n FAILED.
\n SKIPPED: CloudFormation has skipped calling the account gate function for this account and\n Region, for one of the following reasons:
An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with\n the stack set operation in this account and Region.
\nThe AWSCloudFormationStackSetExecutionRole of the stack set administration account lacks\n permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account\n and Region.
Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack\n set operation in this account and Region.
\nThe reason for the account gate status assigned to this account and Region for the stack set operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Structure that contains the results of the account gate function which CloudFormation invokes, if present,\n before proceeding with a stack set operation in an account and Region.
\nFor each account and Region, CloudFormation lets you specify a Lambda function that encapsulates\n any requirements that must be met before CloudFormation can proceed with a stack set operation in that\n account and Region. CloudFormation invokes the function each time a stack set operation is requested for\n that account and Region; if the function returns FAILED, CloudFormation cancels the operation\n in that account and Region, and sets the stack set operation result status for that account and Region to\n FAILED.
For more information, see Configuring a target account\n gate.
" + } }, - { - "target": "com.amazonaws.cloudformation#CreateStack" + "com.amazonaws.cloudformation#AccountGateStatus": { + "type": "enum", + "members": { + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "SKIPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED" + } + } + } }, - { - "target": "com.amazonaws.cloudformation#CreateStackInstances" + "com.amazonaws.cloudformation#AccountGateStatusReason": { + "type": "string" }, - { - "target": "com.amazonaws.cloudformation#CreateStackSet" + "com.amazonaws.cloudformation#AccountLimit": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudformation#LimitName", + "traits": { + "smithy.api#documentation": "The name of the account limit.
\nValues: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit\n
The value that's associated with the account limit name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The AccountLimit data type.
\nCloudFormation has the following limits per account:
\nNumber of concurrent resources
\nNumber of stacks
\nNumber of stack outputs
\nFor more information about these account limits, and other CloudFormation limits, see CloudFormation\n quotas in the CloudFormation User Guide.
" + } }, - { - "target": "com.amazonaws.cloudformation#DeactivateOrganizationsAccess" + "com.amazonaws.cloudformation#AccountLimitList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#AccountLimit" + } }, - { - "target": "com.amazonaws.cloudformation#DeactivateType" + "com.amazonaws.cloudformation#AccountList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Account" + } }, - { - "target": "com.amazonaws.cloudformation#DeleteChangeSet" + "com.amazonaws.cloudformation#AccountsUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5120 + }, + "smithy.api#pattern": "^(s3://|http(s?)://).+$" + } }, - { - "target": "com.amazonaws.cloudformation#DeleteStack" + "com.amazonaws.cloudformation#ActivateOrganizationsAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ActivateOrganizationsAccessOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Activate trusted access with Organizations. With trusted access between StackSets\n and Organizations activated, the management account has permissions to create\n and manage StackSets for your organization.
" + } }, - { - "target": "com.amazonaws.cloudformation#DeleteStackInstances" + "com.amazonaws.cloudformation#ActivateOrganizationsAccessInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudformation#DeleteStackSet" + "com.amazonaws.cloudformation#ActivateOrganizationsAccessOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudformation#DeregisterType" + "com.amazonaws.cloudformation#ActivateType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ActivateTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ActivateTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see\n Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#idempotent": {} + } }, - { - "target": "com.amazonaws.cloudformation#DescribeAccountLimits" + "com.amazonaws.cloudformation#ActivateTypeInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#ThirdPartyType", + "traits": { + "smithy.api#documentation": "The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" + } + }, + "AutoUpdate": { + "target": "com.amazonaws.cloudformation#AutoUpdate", + "traits": { + "smithy.api#documentation": "Whether to automatically update the extension in this account and Region when a new minor\n version is published by the extension publisher. Major versions released by the publisher must be manually\n updated.
\nThe default is true.
Contains logging configuration information for an extension.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.cloudformation#RoleARN2", + "traits": { + "smithy.api#documentation": "The name of the IAM execution role to use to activate the extension.
" + } + }, + "VersionBump": { + "target": "com.amazonaws.cloudformation#VersionBump", + "traits": { + "smithy.api#documentation": "Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is\n available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is\n available.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of\n the major version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
The Amazon Resource Name (ARN) of the activated extension, in this account and Region.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudformation#DescribeChangeSetHooks" + "com.amazonaws.cloudformation#AllowedValue": { + "type": "string" }, - { - "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccess" + "com.amazonaws.cloudformation#AllowedValues": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#AllowedValue" + } }, - { - "target": "com.amazonaws.cloudformation#DescribePublisher" + "com.amazonaws.cloudformation#AlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AlreadyExistsException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The resource with the name requested already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus" + "com.amazonaws.cloudformation#Arn": { + "type": "string" }, - { - "target": "com.amazonaws.cloudformation#DescribeStackEvents" + "com.amazonaws.cloudformation#AutoDeployment": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.cloudformation#AutoDeploymentNullable", + "traits": { + "smithy.api#documentation": "If set to true, StackSets automatically deploys additional stack instances to Organizations\n accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account\n is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified\n Regions.
If set to true, stack resources are retained when an account is removed from a target organization\n or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to\n True.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" + } }, - { - "target": "com.amazonaws.cloudformation#DescribeStackInstance" + "com.amazonaws.cloudformation#AutoDeploymentNullable": { + "type": "boolean" }, - { - "target": "com.amazonaws.cloudformation#DescribeStackResource" + "com.amazonaws.cloudformation#AutoUpdate": { + "type": "boolean" }, - { - "target": "com.amazonaws.cloudformation#DescribeStackResourceDrifts" + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeConfigurationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + } }, - { - "target": "com.amazonaws.cloudformation#DescribeStackResources" + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.cloudformation#ErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message.
" + } + }, + "TypeConfigurationIdentifier": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier", + "traits": { + "smithy.api#documentation": "Identifying information for the configuration of a CloudFormation extension.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information concerning an error generated during the setting of configuration data for a CloudFormation extension.
" + } }, - { - "target": "com.amazonaws.cloudformation#DescribeStacks" + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError" + } }, - { - "target": "com.amazonaws.cloudformation#DescribeStackSet" + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsInput": { + "type": "structure", + "members": { + "TypeConfigurationIdentifiers": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifiers", + "traits": { + "smithy.api#documentation": "The list of identifiers for the desired extension configurations.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudformation#DescribeStackSetOperation" + "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsOutput": { + "type": "structure", + "members": { + "Errors": { + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors", + "traits": { + "smithy.api#documentation": "A list of information concerning any errors generated during the setting of the specified configurations.
" + } + }, + "UnprocessedTypeConfigurations": { + "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", + "traits": { + "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any\n reason.
" + } + }, + "TypeConfigurations": { + "target": "com.amazonaws.cloudformation#TypeConfigurationDetailsList", + "traits": { + "smithy.api#documentation": "A list of any of the specified extension configurations from the CloudFormation registry.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } }, - { - "target": "com.amazonaws.cloudformation#DescribeType" + "com.amazonaws.cloudformation#BoxedInteger": { + "type": "integer" }, - { - "target": "com.amazonaws.cloudformation#DescribeTypeRegistration" + "com.amazonaws.cloudformation#BoxedMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.cloudformation#DetectStackDrift" + "com.amazonaws.cloudformation#CFNRegistryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "An message with details about the error that occurred.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CFNRegistryException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "An error occurred during a CloudFormation registry operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } }, - { - "target": "com.amazonaws.cloudformation#DetectStackResourceDrift" + "com.amazonaws.cloudformation#CallAs": { + "type": "enum", + "members": { + "SELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELF" + } + }, + "DELEGATED_ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELEGATED_ADMIN" + } + } + } }, - { - "target": "com.amazonaws.cloudformation#DetectStackSetDrift" + "com.amazonaws.cloudformation#CancelUpdateStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#CancelUpdateStackInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update\n and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
If you don't pass a parameter to StackName, the API returns a response that describes\n all resources in the account.
The IAM policy below can be added to\n IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\":\n \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same\n name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received\n them.
The input for the CancelUpdateStack action.
", + "smithy.api#input": {} + } }, - { - "target": "com.amazonaws.cloudformation#ExecuteChangeSet" + "com.amazonaws.cloudformation#Capabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Capability" + } }, - { - "target": "com.amazonaws.cloudformation#GetStackPolicy" + "com.amazonaws.cloudformation#CapabilitiesReason": { + "type": "string" }, - { - "target": "com.amazonaws.cloudformation#GetTemplate" + "com.amazonaws.cloudformation#Capability": { + "type": "enum", + "members": { + "CAPABILITY_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPABILITY_IAM" + } + }, + "CAPABILITY_NAMED_IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPABILITY_NAMED_IAM" + } + }, + "CAPABILITY_AUTO_EXPAND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CAPABILITY_AUTO_EXPAND" + } + } + } }, - { - "target": "com.amazonaws.cloudformation#GetTemplateSummary" - }, - { - "target": "com.amazonaws.cloudformation#ImportStacksToStackSet" - }, - { - "target": "com.amazonaws.cloudformation#ListChangeSets" - }, - { - "target": "com.amazonaws.cloudformation#ListExports" - }, - { - "target": "com.amazonaws.cloudformation#ListImports" - }, - { - "target": "com.amazonaws.cloudformation#ListStackInstanceResourceDrifts" - }, - { - "target": "com.amazonaws.cloudformation#ListStackInstances" - }, - { - "target": "com.amazonaws.cloudformation#ListStackResources" + "com.amazonaws.cloudformation#Category": { + "type": "enum", + "members": { + "REGISTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REGISTERED" + } + }, + "ACTIVATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVATED" + } + }, + "THIRD_PARTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIRD_PARTY" + } + }, + "AWS_TYPES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_TYPES" + } + } + } }, - { - "target": "com.amazonaws.cloudformation#ListStacks" + "com.amazonaws.cloudformation#CausingEntity": { + "type": "string" }, - { - "target": "com.amazonaws.cloudformation#ListStackSetOperationResults" + "com.amazonaws.cloudformation#Change": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#ChangeType", + "traits": { + "smithy.api#documentation": "The type of entity that CloudFormation changes. Currently, the only entity type is\n Resource.
Is either null, if no hooks invoke for the resource, or contains the number of hooks that will\n invoke for the resource.
A ResourceChange structure that describes the resource and action that CloudFormation will\n perform.
The Change structure describes the changes CloudFormation will perform if you execute the\n change set.
Specifies the points in provisioning logic where a hook is invoked.
" + } + }, + "FailureMode": { + "target": "com.amazonaws.cloudformation#HookFailureMode", + "traits": { + "smithy.api#documentation": "Specify the hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
The unique name for your hook. Specifies a three-part namespace for your hook, with a recommended pattern of\n Organization::Service::Hook.
The following organization namespaces are reserved and can't be used in your hook type names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n ASK\n
\n AWS\n
\n Custom\n
\n Dev\n
The version ID of the type specified.
" + } + }, + "TypeConfigurationVersionId": { + "target": "com.amazonaws.cloudformation#HookTypeConfigurationVersionId", + "traits": { + "smithy.api#documentation": "The version ID of the type configuration.
" + } + }, + "TargetDetails": { + "target": "com.amazonaws.cloudformation#ChangeSetHookTargetDetails", + "traits": { + "smithy.api#documentation": "Specifies details about the target that the hook will run against.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the resource, the hook, and the hook version to be invoked.
" + } }, - { - "target": "com.amazonaws.cloudformation#ListTypeRegistrations" + "com.amazonaws.cloudformation#ChangeSetHookResourceTargetDetails": { + "type": "structure", + "members": { + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The resource's logical ID, which is defined in the stack's template.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#HookTargetTypeName", + "traits": { + "smithy.api#documentation": "The type of CloudFormation resource, such as AWS::S3::Bucket.
Specifies the action of the resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies RESOURCE type target details for activated hooks.
The name of the type.
" + } + }, + "ResourceTargetDetails": { + "target": "com.amazonaws.cloudformation#ChangeSetHookResourceTargetDetails", + "traits": { + "smithy.api#documentation": "Required if TargetType is RESOURCE.
Specifies target details for an activated hook.
" + } }, - { - "target": "com.amazonaws.cloudformation#ListTypeVersions" + "com.amazonaws.cloudformation#ChangeSetHooks": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ChangeSetHook" + } }, - { - "target": "com.amazonaws.cloudformation#PublishType" + "com.amazonaws.cloudformation#ChangeSetHooksStatus": { + "type": "enum", + "members": { + "PLANNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLANNING" + } + }, + "PLANNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLANNED" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + } + } }, - { - "target": "com.amazonaws.cloudformation#RecordHandlerProgress" + "com.amazonaws.cloudformation#ChangeSetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^arn:[-a-zA-Z0-9:/]*$" + } }, - { - "target": "com.amazonaws.cloudformation#RegisterPublisher" + "com.amazonaws.cloudformation#ChangeSetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$" + } }, - { - "target": "com.amazonaws.cloudformation#RegisterType" + "com.amazonaws.cloudformation#ChangeSetNameOrId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*$" + } }, - { - "target": "com.amazonaws.cloudformation#RollbackStack" + "com.amazonaws.cloudformation#ChangeSetNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ChangeSetNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the\n ListChangeSets operation.
The ID of the stack with which the change set is associated.
" + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name of the stack with which the change set is associated.
" + } + }, + "ChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", + "traits": { + "smithy.api#documentation": "The ID of the change set.
" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetName", + "traits": { + "smithy.api#documentation": "The name of the change set.
" + } + }, + "ExecutionStatus": { + "target": "com.amazonaws.cloudformation#ExecutionStatus", + "traits": { + "smithy.api#documentation": "If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
A description of the change set's status. For example, if your change set is in the FAILED state,\n CloudFormation shows the error message.
The start time when the change set was created, in UTC.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "Descriptive information about the change set.
" + } + }, + "IncludeNestedStacks": { + "target": "com.amazonaws.cloudformation#IncludeNestedStacks", + "traits": { + "smithy.api#documentation": "Specifies the current setting of IncludeNestedStacks for the change set.
The parent change set ID.
" + } + }, + "RootChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", + "traits": { + "smithy.api#documentation": "The root change set ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The ChangeSetSummary structure describes a change set, its status, and the stack with which it's\n associated.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably\n and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build\n highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member\n resources of the stack together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information\n about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", - "smithy.api#title": "AWS CloudFormation", - "smithy.api#xmlNamespace": { - "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" - }, - "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": [ + "com.amazonaws.cloudformation#CloudFormation": { + "type": "service", + "version": "2010-05-15", + "operations": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.cloudformation#ActivateOrganizationsAccess" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.cloudformation#ActivateType" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurations" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ + "target": "com.amazonaws.cloudformation#CancelUpdateStack" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.cloudformation#ContinueUpdateRollback" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://cloudformation-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://cloudformation.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://cloudformation-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://cloudformation.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://cloudformation.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation-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://cloudformation-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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation-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://cloudformation-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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://cloudformation.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-west-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://cloudformation-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://cloudformation.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://cloudformation-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.cloudformation#ConfigurationSchema": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 60000 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.cloudformation#ConnectionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" - } - }, - "com.amazonaws.cloudformation#ContinueUpdateRollback": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ContinueUpdateRollbackInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ContinueUpdateRollbackOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all\n changes after a failed stack update. For example, you might have a stack that's rolling back to an old database\n instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was\n deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update\n rollback to fail.
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" - } - }, - "ResourcesToSkip": { - "target": "com.amazonaws.cloudformation#ResourcesToSkip", - "traits": { - "smithy.api#documentation": "A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback\n operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed.\n You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because\n an update was canceled. To check why a resource update failed, use the DescribeStackResources\n action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back.\n We recommend that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified\n resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the\n state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before\n performing another stack update, you must update the stack or resources to be consistent with each other. If you\n don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with\n the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
The input for the ContinueUpdateRollback action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ContinueUpdateRollbackOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "The output for a ContinueUpdateRollback operation.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#CreateChangeSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#CreateChangeSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#CreateChangeSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#AlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" - }, - { - "target": "com.amazonaws.cloudformation#LimitExceededException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you\n create a change set for an existing stack, CloudFormation compares the stack's information with the information\n that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update\n a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT\n for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,\n CloudFormation starts creating the change set. To check the status of the change set or to review it, use the\n DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change\n set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the\n change set by comparing this stack's information with the information that you submit, such as a modified template or\n different parameter input values.
", - "smithy.api#required": {} - } - }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the\n stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the\n change set by comparing this template with the stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
Whether to reuse the template that's associated with the stack to create the change set.
" - } - }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the change set. For more\n information, see the Parameter data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom\n processing on templates.
\nThe template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Controlling access\n with Identity and Access Management in the CloudFormation User Guide.
" - } - }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation\n assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure\n that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If\n no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" - } - }, - "RollbackConfiguration": { - "target": "com.amazonaws.cloudformation#RollbackConfiguration", - "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" - } - }, - "NotificationARNs": { - "target": "com.amazonaws.cloudformation#NotificationARNs", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation\n associates with the stack. To remove all associated notification topics, specify an empty list.
" - } - }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", - "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the\n stack. You can specify a maximum of 50 tags.
" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetName", - "traits": { - "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are associated with the specified\n stack.
\nA change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an\n alphabetical character and can't exceed 128 characters.
", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.cloudformation#ClientToken", - "traits": { - "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name.\n You might retry CreateChangeSet requests to ensure that CloudFormation successfully received\n them.
A description to help you identify this change set.
" - } - }, - "ChangeSetType": { - "target": "com.amazonaws.cloudformation#ChangeSetType", - "traits": { - "smithy.api#documentation": "The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no\n template or resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to\n create a change set for a new stack or the CREATE type to create a change set for an existing\n stack.
The resources to import into your stack.
" - } - }, - "IncludeNestedStacks": { - "target": "com.amazonaws.cloudformation#IncludeNestedStacks", - "traits": { - "smithy.api#documentation": "Creates a change set for the all nested stacks specified in the template. The default behavior of this action is\n set to False. To include nested sets in a change set, specify True.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
The input for the CreateChangeSet action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#CreateChangeSetOutput": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.cloudformation#ChangeSetId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the change set.
" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The unique ID of the stack.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for the CreateChangeSet action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#CreateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#CreateStackInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#CreateStackOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#AlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" - }, - { - "target": "com.amazonaws.cloudformation#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.\n You can check the status of the stack through the DescribeStacks operation.
" - } - }, - "com.amazonaws.cloudformation#CreateStackInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name that's associated with the stack. The name must be unique in the Region in which you are creating the\n stack.
\nA stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an\n alphabetical character and can't be longer than 128 characters.
\nStructure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template anatomy in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" - } - }, - "TimeoutInMinutes": { - "target": "com.amazonaws.cloudformation#TimeoutMinutes", - "traits": { - "smithy.api#documentation": "The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback\n is not set or is set to false, the stack will be rolled back.
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros to perform custom\n processing on templates.
\nThe template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a specific custom resource), AWS::service_name::* (for all resources\n of a particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
" - } - }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" - } - }, - "OnFailure": { - "target": "com.amazonaws.cloudformation#OnFailure", - "traits": { - "smithy.api#documentation": "Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources\n created in the stack. A maximum number of 50 tags can be specified.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with\n termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks\n by default.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" - } - }, - "RetainExceptOnCreate": { - "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", - "traits": { - "smithy.api#documentation": "This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
The input for CreateStack action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#CreateStackInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#CreateStackInstancesInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#CreateStackInstancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudformation#OperationInProgressException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StaleRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.
The name or unique ID of the stack set that you want to create stack instances from.
", - "smithy.api#required": {} - } - }, - "Accounts": { - "target": "com.amazonaws.cloudformation#AccountList", - "traits": { - "smithy.api#documentation": "[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack\n instances in the specified Region(s) for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts for which to create stack instances in the\n specified Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not both.
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.
", - "smithy.api#required": {} - } - }, - "ParameterOverrides": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets\n parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template.
" - } - }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", - "traits": { - "smithy.api#documentation": "Preferences for how CloudFormation performs this stack set operation.
" - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe unique identifier for this stack set operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#CreateStackOutput": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "Unique identifier of the stack.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for a CreateStack action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#CreateStackSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#CreateStackSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#CreateStackSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CreatedButModifiedException" - }, - { - "target": "com.amazonaws.cloudformation#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudformation#NameAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a stack set.
" - } - }, - "com.amazonaws.cloudformation#CreateStackSetInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name to associate with the stack set. The name must be unique in the Region where you create your stack\n set.
\nA stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an\n alphabetic character and can't be longer than 128 characters.
\nA description of the stack set. You can use the description to identify the stack set's purpose or other\n important information.
" - } - }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" - } - }, - "TemplateURL": { - "target": "com.amazonaws.cloudformation#TemplateURL", - "traits": { - "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.
" - } - }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "The input parameters for the stack set template.
" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you\n have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the stack set is not\n created.
The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" - } - }, - "ExecutionRoleName": { - "target": "com.amazonaws.cloudformation#ExecutionRoleName", - "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
" - } - }, - "PermissionModel": { - "target": "com.amazonaws.cloudformation#PermissionModels", - "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same\n name. You might retry CreateStackSet requests to ensure that CloudFormation successfully\n received them.
If you don't specify an operation ID, the SDK generates one automatically.
", - "smithy.api#idempotencyToken": {} - } - }, - "ManagedExecution": { - "target": "com.amazonaws.cloudformation#ManagedExecution", - "traits": { - "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#CreateStackSetOutput": { - "type": "structure", - "members": { - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "The ID of the stack set that you're creating.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#CreatedButModifiedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "CreatedButModifiedException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "The specified resource exists, but has been changed.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cloudformation#CreationTime": { - "type": "timestamp" - }, - "com.amazonaws.cloudformation#DeactivateOrganizationsAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DeactivateOrganizationsAccessOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated,\n the management account does not have permissions to create and manage\n service-managed StackSets for your organization.
" - } - }, - "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DeactivateOrganizationsAccessOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DeactivateType": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DeactivateTypeInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DeactivateTypeOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - }, - { - "target": "com.amazonaws.cloudformation#TypeNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack\n update operations where the stack template includes the extension, even if no updates are being made to the\n extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is\n released.
", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#DeactivateTypeInput": { - "type": "structure", - "members": { - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The type name of the extension, in this account and Region. If you specified a type name alias when enabling the\n extension, use the type name alias.
\nConditional: You must specify either Arn, or TypeName and Type.
The extension type.
\nConditional: You must specify either Arn, or TypeName and Type.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nConditional: You must specify either Arn, or TypeName and Type.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the change set.
\nIf IncludeNestedStacks specifies True during the creation of the nested change set,\n then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also\n delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
The name or Amazon Resource Name (ARN) of the change set that you want to delete.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's\n associated with it.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the DeleteChangeSet action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DeleteChangeSetOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "The output for the DeleteChangeSet action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DeleteStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DeleteStackInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't\n show up in the DescribeStacks operation if the deletion has been completed successfully.
" - } - }, - "com.amazonaws.cloudformation#DeleteStackInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack.
", - "smithy.api#required": {} - } - }, - "RetainResources": { - "target": "com.amazonaws.cloudformation#RetainResources", - "traits": { - "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the\n retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" - } - }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your\n behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n DeleteStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The input for DeleteStack action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DeleteStackInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DeleteStackInstancesInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DeleteStackInstancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudformation#OperationInProgressException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StaleRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
" - } - }, - "com.amazonaws.cloudformation#DeleteStackInstancesInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to delete stack instances for.
", - "smithy.api#required": {} - } - }, - "Accounts": { - "target": "com.amazonaws.cloudformation#AccountList", - "traits": { - "smithy.api#documentation": "[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances\n for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
\nYou can specify Accounts or DeploymentTargets, but not both.
The Amazon Web Services Regions where you want to delete stack set instances.
", - "smithy.api#required": {} - } - }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", - "traits": { - "smithy.api#documentation": "Preferences for how CloudFormation performs this stack set operation.
" - } - }, - "RetainStacks": { - "target": "com.amazonaws.cloudformation#RetainStacks", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.
\nFor more information, see Stack set operation\n options.
", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You can retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe unique identifier for this stack set operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DeleteStackSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DeleteStackSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DeleteStackSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#OperationInProgressException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotEmptyException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more\n information about how to complete this, see DeleteStackInstances.
" - } - }, - "com.amazonaws.cloudformation#DeleteStackSetInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
", - "smithy.api#required": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
" - } - }, - "AccountsUrl": { - "target": "com.amazonaws.cloudformation#AccountsUrl", - "traits": { - "smithy.api#documentation": "Returns the value of the AccountsUrl property.
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
" - } - }, - "AccountFilterType": { - "target": "com.amazonaws.cloudformation#AccountFilterType", - "traits": { - "smithy.api#documentation": "Limit deployment targets to individual accounts or include additional accounts with provided OUs.
\nThe following is a list of possible values for the AccountFilterType operation.
\n INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.\n
\n DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This\n enables user to avoid certain accounts within an OU such as suspended accounts.
\n UNION: StackSets includes additional accounts deployment targets.
This is the default value if AccountFilterType is not provided. This enables user to update an\n entire OU and individual accounts from a different OU in one request, which used to be two separate\n requests.
\n NONE: Deploys to all the accounts in specified organizational units (OU).
[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't\n deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.
\nFor update operations, you can specify either Accounts or OrganizationalUnitIds. For\n create and delete operations, specify OrganizationalUnitIds.
Marks an extension or extension version as DEPRECATED in the CloudFormation registry,\n removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation\n operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#DeregisterTypeInput": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#PrivateTypeArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DeregisterTypeOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeAccountLimits": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeAccountLimitsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" - }, - "traits": { - "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in\n your account. For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AccountLimits" - } - } - }, - "com.amazonaws.cloudformation#DescribeAccountLimitsInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string that identifies the next page of limits that you want to retrieve.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the DescribeAccountLimits action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeAccountLimitsOutput": { - "type": "structure", - "members": { - "AccountLimits": { - "target": "com.amazonaws.cloudformation#AccountLimitList", - "traits": { - "smithy.api#documentation": "An account limit structure that contain a list of CloudFormation account limits and their values.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page\n exists, this value is null.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for the DescribeAccountLimits action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeChangeSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeChangeSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeChangeSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the\n change set. For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", - "smithy.api#suppress": [ - "WaitableTraitInvalidErrorType" - ], - "smithy.waiters#waitable": { - "ChangeSetCreateComplete": { - "documentation": "Wait until change set status is CREATE_COMPLETE.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Status", - "expected": "CREATE_COMPLETE", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Status", - "expected": "FAILED", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "errorType": "ValidationError" - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.cloudformation#DescribeChangeSetHooks": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeChangeSetHooksInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeChangeSetHooksOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you\n run the change set.
" - } - }, - "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { - "type": "structure", - "members": { - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", - "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want to describe.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want\n to describe.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of\n information that you want to retrieve.
If specified, lists only the hooks related to the specified LogicalResourceId.
The change set identifier (stack ID).
" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetName", - "traits": { - "smithy.api#documentation": "The change set name.
" - } - }, - "Hooks": { - "target": "com.amazonaws.cloudformation#ChangeSetHooks", - "traits": { - "smithy.api#documentation": "List of hook objects.
" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#ChangeSetHooksStatus", - "traits": { - "smithy.api#documentation": "Provides the status of the change set hook.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "Pagination token, null or empty if no more results.
The stack identifier (stack ID).
" - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The stack name.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeChangeSetInput": { - "type": "structure", - "members": { - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", - "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want to describe.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to\n describe.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string (provided by the DescribeChangeSet response output) that identifies the next page of\n information that you want to retrieve.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the DescribeChangeSet action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeChangeSetOutput": { - "type": "structure", - "members": { - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetName", - "traits": { - "smithy.api#documentation": "The name of the change set.
" - } - }, - "ChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the change set.
" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stack that's associated with the change set.
" - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name of the stack that's associated with the change set.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "Information about the change set.
" - } - }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the Parameter data type.
The start time when the change set was created, in UTC.
" - } - }, - "ExecutionStatus": { - "target": "com.amazonaws.cloudformation#ExecutionStatus", - "traits": { - "smithy.api#documentation": "If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
" - } - }, - "NotificationARNs": { - "target": "com.amazonaws.cloudformation#NotificationARNs", - "traits": { - "smithy.api#documentation": "The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you\n execute the change set.
" - } - }, - "RollbackConfiguration": { - "target": "com.amazonaws.cloudformation#RollbackConfiguration", - "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set\n was created.
" - } - }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", - "traits": { - "smithy.api#documentation": "If you execute the change set, the tags that will be associated with the stack.
" - } - }, - "Changes": { - "target": "com.amazonaws.cloudformation#Changes", - "traits": { - "smithy.api#documentation": "A list of Change structures that describes the resources CloudFormation changes if you execute\n the change set.
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page,\n this value is null.
" - } - }, - "IncludeNestedStacks": { - "target": "com.amazonaws.cloudformation#IncludeNestedStacks", - "traits": { - "smithy.api#documentation": "Verifies if IncludeNestedStacks is set to True.
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
" - } - }, - "RootChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", - "traits": { - "smithy.api#documentation": "Specifies the change set ID of the root change set in the current nested change set hierarchy.
" - } - }, - "OnStackFailure": { - "target": "com.amazonaws.cloudformation#OnStackFailure", - "traits": { - "smithy.api#documentation": "Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
The output for the DescribeChangeSet action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeOrganizationsAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccessInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccessOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\nPresents the status of the OrganizationAccess.
Returns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide\n
\nThe ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
The ID of the extension publisher.
" - } - }, - "PublisherStatus": { - "target": "com.amazonaws.cloudformation#PublisherStatus", - "traits": { - "smithy.api#documentation": "Whether the publisher is verified. Currently, all registered publishers are verified.
" - } - }, - "IdentityProvider": { - "target": "com.amazonaws.cloudformation#IdentityProvider", - "traits": { - "smithy.api#documentation": "The type of account used as the identity provider when registering this publisher with CloudFormation.
" - } - }, - "PublisherProfile": { - "target": "com.amazonaws.cloudformation#PublisherProfile", - "traits": { - "smithy.api#documentation": "The URL to the publisher's profile with the identity provider.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" - }, - "traits": { - "smithy.api#documentation": "Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The ID of the stack.
", - "smithy.api#required": {} - } - }, - "StackDriftDetectionId": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionId", - "traits": { - "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.
", - "smithy.api#required": {} - } - }, - "StackDriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all\n resources in the stack that support drift detection. (Resources that don't currently support stack detection remain\n unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,\n only the resources with those logical IDs are checked for drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the\n stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
The reason the stack drift detection operation has its current status.
" - } - }, - "DriftedStackResourceCount": { - "target": "com.amazonaws.cloudformation#BoxedInteger", - "traits": { - "smithy.api#documentation": "Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is\n IN_SYNC.
Time at which the stack drift detection operation was initiated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStackEventsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStackEventsOutput" - }, - "traits": { - "smithy.api#documentation": "Returns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, go to Stacks in the CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string that identifies the next page of events that you want to retrieve.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for DescribeStackEvents action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackEventsOutput": { - "type": "structure", - "members": { - "StackEvents": { - "target": "com.amazonaws.cloudformation#StackEvents", - "traits": { - "smithy.api#documentation": "A list of StackEvents structures.
If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page\n exists, this value is null.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for a DescribeStackEvents action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStackInstanceInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStackInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" - } - }, - "com.amazonaws.cloudformation#DescribeStackInstanceInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or the unique stack ID of the stack set that you want to get stack instance information for.
", - "smithy.api#required": {} - } - }, - "StackInstanceAccount": { - "target": "com.amazonaws.cloudformation#Account", - "traits": { - "smithy.api#documentation": "The ID of an Amazon Web Services account that's associated with this stack instance.
", - "smithy.api#required": {} - } - }, - "StackInstanceRegion": { - "target": "com.amazonaws.cloudformation#Region", - "traits": { - "smithy.api#documentation": "The name of a Region that's associated with this stack instance.
", - "smithy.api#required": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe stack instance that matches the specified request parameters.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStackResourceInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStackResourceOutput" - }, - "traits": { - "smithy.api#documentation": "Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.
" - } - }, - "com.amazonaws.cloudformation#DescribeStackResourceDrifts": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput" - }, - "traits": { - "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the specified stack. This\n includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudformation#DescribeStackResourceDriftsInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "The name of the stack for which you want drift information.
", - "smithy.api#required": {} - } - }, - "StackResourceDriftStatusFilters": { - "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", - "traits": { - "smithy.api#documentation": "The resource drift status values to use as filters for the resource drift results returned.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
A string that identifies the next page of stack resource drift results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.cloudformation#BoxedMaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
Drift information for the resources that have been checked for drift in the specified stack. This includes\n actual and expected configuration values for resources where CloudFormation detects drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", - "smithy.api#required": {} - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource as specified in the template.
\nDefault: There is no default value.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The input for DescribeStackResource action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackResourceOutput": { - "type": "structure", - "members": { - "StackResourceDetail": { - "target": "com.amazonaws.cloudformation#StackResourceDetail", - "traits": { - "smithy.api#documentation": "A StackResourceDetail structure containing the description of the specified resource in the\n specified stack.
The output for a DescribeStackResource action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStackResourcesInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStackResourcesOutput" - }, - "traits": { - "smithy.api#documentation": "Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The logical name of the resource as specified in the template.
\nDefault: There is no default value.
" - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must specify\n StackName.
Default: There is no default value.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for DescribeStackResources action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackResourcesOutput": { - "type": "structure", - "members": { - "StackResources": { - "target": "com.amazonaws.cloudformation#StackResources", - "traits": { - "smithy.api#documentation": "A list of StackResource structures.
The output for a DescribeStackResources action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStackSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStackSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the description of the specified StackSet.
" - } - }, - "com.amazonaws.cloudformation#DescribeStackSetInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set whose description you want.
", - "smithy.api#required": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nReturns the description of the specified StackSet operation.
" - } - }, - "com.amazonaws.cloudformation#DescribeStackSetOperationInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or the unique stack ID of the stack set for the stack operation.
", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique ID of the stack set operation.
", - "smithy.api#required": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe specified stack set operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStackSetOutput": { - "type": "structure", - "members": { - "StackSet": { - "target": "com.amazonaws.cloudformation#StackSet", - "traits": { - "smithy.api#documentation": "The specified stack set.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeStacks": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeStacksInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeStacksOutput" - }, - "traits": { - "smithy.api#documentation": "Returns the description for the specified stack; if no stack name was specified, then it returns the description\n for all the stacks created.
\nIf the stack doesn't exist, an ValidationError is returned.
If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account. This requires ListStacks and DescribeStacks permissions.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string that identifies the next page of stacks that you want to retrieve.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for DescribeStacks action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeStacksOutput": { - "type": "structure", - "members": { - "Stacks": { - "target": "com.amazonaws.cloudformation#Stacks", - "traits": { - "smithy.api#documentation": "A list of stack structures.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for a DescribeStacks action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeType": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeTypeInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeTypeOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - }, - { - "target": "com.amazonaws.cloudformation#TypeNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns detailed information about an extension that has been registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
The publisher ID of the extension publisher.
\nExtensions provided by Amazon Web Services are not assigned a publisher ID.
" - } - }, - "PublicVersionNumber": { - "target": "com.amazonaws.cloudformation#PublicVersionNumber", - "traits": { - "smithy.api#documentation": "The version number of a public third-party extension.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeTypeOutput": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#TypeArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" - } - }, - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "The kind of extension.
" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation\n returns the type name alias. For more information, see ActivateType.
" - } - }, - "DefaultVersionId": { - "target": "com.amazonaws.cloudformation#TypeVersionId", - "traits": { - "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For\n more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" - } - }, - "IsDefaultVersion": { - "target": "com.amazonaws.cloudformation#IsDefaultVersion", - "traits": { - "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation\n returns null.
The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line\n Interface User Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "The description of the extension.
" - } - }, - "Schema": { - "target": "com.amazonaws.cloudformation#TypeSchema", - "traits": { - "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" - } - }, - "ProvisioningType": { - "target": "com.amazonaws.cloudformation#ProvisioningType", - "traits": { - "smithy.api#documentation": "For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning\n type during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore\n can't actually be provisioned.
create
\nread
\ndelete
\nThe deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see RegisterType.
For extensions that are modules, the public third-party extensions that must be activated in your account in\n order for the module itself to be activated.
" - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.cloudformation#RoleARN2", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This\n applies only to private extensions you have registered in your account. For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your extension with the appropriate\n credentials.
" - } - }, - "Visibility": { - "target": "com.amazonaws.cloudformation#Visibility", - "traits": { - "smithy.api#documentation": "The scope at which the extension is visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account in which it is registered.\n CloudFormation marks any extensions you register as PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.
The URL of the source code for the extension.
" - } - }, - "DocumentationUrl": { - "target": "com.amazonaws.cloudformation#OptionalSecureUrl", - "traits": { - "smithy.api#documentation": "The URL of a page providing detailed documentation for this extension.
" - } - }, - "LastUpdated": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nWhen the specified private extension version was registered or activated in your account.
" - } - }, - "ConfigurationSchema": { - "target": "com.amazonaws.cloudformation#ConfigurationSchema", - "traits": { - "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" - } - }, - "PublisherId": { - "target": "com.amazonaws.cloudformation#PublisherId", - "traits": { - "smithy.api#documentation": "The publisher ID of the extension publisher.
\nThis applies only to public third-party extensions. For private registered extensions, and extensions provided\n by Amazon Web Services, CloudFormation returns null.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of\n the public extension.
" - } - }, - "PublicVersionNumber": { - "target": "com.amazonaws.cloudformation#PublicVersionNumber", - "traits": { - "smithy.api#documentation": "The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns\n null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.
Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions\n for use in your account in the CloudFormation User Guide.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DescribeTypeRegistration": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DescribeTypeRegistrationInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DescribeTypeRegistrationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about an extension's registration, including its current status and type and version\n identifiers.
\nWhen you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
\nOnce the registration request has completed, use DescribeType to return detailed information\n about an extension.
", - "smithy.api#idempotent": {}, - "smithy.waiters#waitable": { - "TypeRegistrationComplete": { - "documentation": "Wait until type registration is COMPLETE.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "ProgressStatus", - "expected": "COMPLETE", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "ProgressStatus", - "expected": "FAILED", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 30 - } - } - } - }, - "com.amazonaws.cloudformation#DescribeTypeRegistrationInput": { - "type": "structure", - "members": { - "RegistrationToken": { - "target": "com.amazonaws.cloudformation#RegistrationToken", - "traits": { - "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using\n RegisterType.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DescribeTypeRegistrationOutput": { - "type": "structure", - "members": { - "ProgressStatus": { - "target": "com.amazonaws.cloudformation#RegistrationStatus", - "traits": { - "smithy.api#documentation": "The current status of the extension registration request.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "The description of the extension registration request.
" - } - }, - "TypeArn": { - "target": "com.amazonaws.cloudformation#TypeArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
The name of the stack for which you want to detect drift.
", - "smithy.api#required": {} - } - }, - "LogicalResourceIds": { - "target": "com.amazonaws.cloudformation#LogicalResourceIds", - "traits": { - "smithy.api#documentation": "The logical names of any resources you want to use as filters.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DetectStackDriftOutput": { - "type": "structure", - "members": { - "StackDriftDetectionId": { - "target": "com.amazonaws.cloudformation#StackDriftDetectionId", - "traits": { - "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DetectStackResourceDrift": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DetectStackResourceDriftInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DetectStackResourceDriftOutput" - }, - "traits": { - "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" - } - }, - "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "The name of the stack to which the resource belongs.
", - "smithy.api#required": {} - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource for which to return drift information.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#DetectStackResourceDriftOutput": { - "type": "structure", - "members": { - "StackResourceDrift": { - "target": "com.amazonaws.cloudformation#StackResourceDrift", - "traits": { - "smithy.api#documentation": "Information about whether the resource's actual configuration has drifted from its expected template\n configuration, including actual and expected property values and any differences detected.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DetectStackSetDrift": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#DetectStackSetDriftInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#DetectStackSetDriftOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationInProgressException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs\n drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation\n performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" - } - }, - "com.amazonaws.cloudformation#DetectStackSetDriftInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetNameOrId", - "traits": { - "smithy.api#documentation": "The name of the stack set on which to perform the drift detection operation.
", - "smithy.api#required": {} - } - }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", - "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "\n The ID of the stack set operation.\n
", - "smithy.api#idempotencyToken": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe ID of the drift detection stack set operation.
\nYou can use this operation ID with DescribeStackSetOperation to monitor the progress of the\n drift detection operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#DifferenceType": { - "type": "enum", - "members": { - "ADD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADD" - } - }, - "REMOVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOVE" - } - }, - "NOT_EQUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_EQUAL" - } - } - } - }, - "com.amazonaws.cloudformation#DisableRollback": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#DriftedStackInstancesCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudformation#EnableTerminationProtection": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#ErrorCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 3 - } - } - }, - "com.amazonaws.cloudformation#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.cloudformation#EstimateTemplateCost": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#EstimateTemplateCostInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#EstimateTemplateCostOutput" - }, - "traits": { - "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly\n Calculator URL with a query string that describes the resources required to run the template.
" - } - }, - "com.amazonaws.cloudformation#EstimateTemplateCostInput": { - "type": "structure", - "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
A list of Parameter structures that specify input parameters.
The input for an EstimateTemplateCost action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#EstimateTemplateCostOutput": { - "type": "structure", - "members": { - "Url": { - "target": "com.amazonaws.cloudformation#Url", - "traits": { - "smithy.api#documentation": "An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to\n run the template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for a EstimateTemplateCost action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#EvaluationType": { - "type": "enum", - "members": { - "Static": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Static" - } - }, - "Dynamic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Dynamic" - } - } - } - }, - "com.amazonaws.cloudformation#EventId": { - "type": "string" - }, - "com.amazonaws.cloudformation#ExecuteChangeSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ExecuteChangeSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ExecuteChangeSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" - }, - { - "target": "com.amazonaws.cloudformation#InvalidChangeSetStatusException" - }, - { - "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack\n because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You\n can't specify a temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's\n associated with the change set you want to execute.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with\n the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.
Preserves the state of previously provisioned resources when an operation\n fails. This parameter can't be specified when\n the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True\n
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
The input for the ExecuteChangeSet action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ExecuteChangeSetOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "The output for the ExecuteChangeSet action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ExecutionRoleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z_0-9+=,.@-]+$" - } - }, - "com.amazonaws.cloudformation#ExecutionStatus": { - "type": "enum", - "members": { - "UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNAVAILABLE" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "EXECUTE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXECUTE_IN_PROGRESS" - } - }, - "EXECUTE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXECUTE_COMPLETE" - } - }, - "EXECUTE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXECUTE_FAILED" - } - }, - "OBSOLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OBSOLETE" - } - } - } - }, - "com.amazonaws.cloudformation#Export": { - "type": "structure", - "members": { - "ExportingStackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The stack that contains the exported output name and value.
" - } - }, - "Name": { - "target": "com.amazonaws.cloudformation#ExportName", - "traits": { - "smithy.api#documentation": "The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.
The Export structure describes the exported output values for a stack.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.
" - } - }, - "com.amazonaws.cloudformation#GetStackPolicyInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to get.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the GetStackPolicy action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#GetStackPolicyOutput": { - "type": "structure", - "members": { - "StackPolicyBody": { - "target": "com.amazonaws.cloudformation#StackPolicyBody", - "traits": { - "smithy.api#documentation": "Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for the GetStackPolicy action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#GetTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#GetTemplateInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#GetTemplateOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the template body for a specified stack. You can get the template for running or deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been\n deleted.
If the template doesn't exist, a ValidationError is returned.
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" - } - }, - "ChangeSetName": { - "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", - "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has\n processed all transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
The input for a GetTemplate action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#GetTemplateOutput": { - "type": "structure", - "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nCloudFormation returns the same template that was used when the stack was created.
" - } - }, - "StagesAvailable": { - "target": "com.amazonaws.cloudformation#StageList", - "traits": { - "smithy.api#documentation": "The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
The output for GetTemplate action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#GetTemplateSummary": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#GetTemplateSummaryInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#GetTemplateSummaryOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns information about a new or existing template. The GetTemplateSummary action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError is returned.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nSpecifies options for the GetTemplateSummary API action.
The input for the GetTemplateSummary action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#GetTemplateSummaryOutput": { - "type": "structure", - "members": { - "Parameters": { - "target": "com.amazonaws.cloudformation#ParameterDeclarations", - "traits": { - "smithy.api#documentation": "A list of parameter declarations that describe various properties for each parameter.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "The value that's defined in the Description property of the template.
The capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those\n actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" - } - }, - "CapabilitiesReason": { - "target": "com.amazonaws.cloudformation#CapabilitiesReason", - "traits": { - "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response element.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
The Amazon Web Services template format version, which identifies the capabilities of the template.
" - } - }, - "Metadata": { - "target": "com.amazonaws.cloudformation#Metadata", - "traits": { - "smithy.api#documentation": "The value that's defined for the Metadata property of the template.
A list of the transforms that are declared in the template.
" - } - }, - "ResourceIdentifierSummaries": { - "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", - "traits": { - "smithy.api#documentation": "A list of resource identifier summaries that describe the target resources of an import operation and the\n properties you can provide during the import to identify the target resources. For example, BucketName\n is a possible identifier property for an AWS::S3::Bucket resource.
An object containing any warnings returned.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for the GetTemplateSummary action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#HandlerErrorCode": { - "type": "enum", - "members": { - "NotUpdatable": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotUpdatable" - } - }, - "InvalidRequest": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidRequest" - } - }, - "AccessDenied": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessDenied" - } - }, - "InvalidCredentials": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidCredentials" - } - }, - "AlreadyExists": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AlreadyExists" - } - }, - "NotFound": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotFound" - } - }, - "ResourceConflict": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ResourceConflict" - } - }, - "Throttling": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Throttling" - } - }, - "ServiceLimitExceeded": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ServiceLimitExceeded" - } - }, - "ServiceTimeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NotStabilized" - } - }, - "GeneralServiceException": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GeneralServiceException" - } - }, - "ServiceInternalError": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ServiceInternalError" - } - }, - "NetworkFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NetworkFailure" - } - }, - "InternalFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InternalFailure" - } - }, - "InvalidTypeConfiguration": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InvalidTypeConfiguration" - } - }, - "HandlerInternalFailure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HandlerInternalFailure" - } - }, - "NonCompliant": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NonCompliant" - } - }, - "Unknown": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Unknown" - } - }, - "UnsupportedTarget": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UnsupportedTarget" - } - } - } - }, - "com.amazonaws.cloudformation#HookFailureMode": { - "type": "enum", - "members": { - "FAIL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAIL" - } - }, - "WARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WARN" - } - } - } - }, - "com.amazonaws.cloudformation#HookInvocationCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.cloudformation#HookInvocationPoint": { - "type": "enum", - "members": { - "PRE_PROVISION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRE_PROVISION" - } - } - } - }, - "com.amazonaws.cloudformation#HookStatus": { - "type": "enum", - "members": { - "HOOK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOOK_IN_PROGRESS" - } - }, - "HOOK_COMPLETE_SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOOK_COMPLETE_SUCCEEDED" - } - }, - "HOOK_COMPLETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOOK_COMPLETE_FAILED" - } - }, - "HOOK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOOK_FAILED" - } - } - } - }, - "com.amazonaws.cloudformation#HookStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.cloudformation#HookTargetType": { - "type": "enum", - "members": { - "RESOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE" - } - } - } - }, - "com.amazonaws.cloudformation#HookTargetTypeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}$" - } - }, - "com.amazonaws.cloudformation#HookType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.cloudformation#HookTypeConfigurationVersionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Za-z0-9-]+$" - } - }, - "com.amazonaws.cloudformation#HookTypeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 196 - } - } - }, - "com.amazonaws.cloudformation#HookTypeVersionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Za-z0-9-]+$" - } - }, - "com.amazonaws.cloudformation#IdentityProvider": { - "type": "enum", - "members": { - "AWS_Marketplace": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_Marketplace" - } - }, - "GitHub": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GitHub" - } - }, - "Bitbucket": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Bitbucket" - } - } - } - }, - "com.amazonaws.cloudformation#ImportStacksToStackSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ImportStacksToStackSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ImportStacksToStackSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#LimitExceededException" - }, - { - "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudformation#OperationInProgressException" - }, - { - "target": "com.amazonaws.cloudformation#StackNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StaleRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a\n new stack set in the same account as the source stack or in a different administrator account and Region, by\n specifying the stack ID of the stack you intend to import.
" - } - }, - "com.amazonaws.cloudformation#ImportStacksToStackSetInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetNameOrId", - "traits": { - "smithy.api#documentation": "The name of the stack set. The name must be unique in the Region where you create your stack set.
", - "smithy.api#required": {} - } - }, - "StackIds": { - "target": "com.amazonaws.cloudformation#StackIdList", - "traits": { - "smithy.api#documentation": "The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a\n time.
\nSpecify either StackIds or StackIdsUrl.
The Amazon S3 URL which contains list of stack ids to be inputted.
\nSpecify either StackIds or StackIdsUrl.
The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
" - } - }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", - "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A unique, user defined, identifier for the stack set operation.
", - "smithy.api#idempotencyToken": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
For service managed stack sets, specify DELEGATED_ADMIN.
The unique identifier for the stack set operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#Imports": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackName" - } - }, - "com.amazonaws.cloudformation#InProgressStackInstancesCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudformation#InSyncStackInstancesCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudformation#IncludeNestedStacks": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#InsufficientCapabilitiesException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InsufficientCapabilitiesException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The template contains resources with capabilities that weren't specified in the Capabilities parameter.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#InvalidChangeSetStatusException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidChangeSetStatus", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The specified change set can't be used to update the stack. For example, the change set status might be\n CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.
The specified operation isn't valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#InvalidStateTransitionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidStateTransition", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#IsActivated": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#IsDefaultConfiguration": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#IsDefaultVersion": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#Key": { - "type": "string" - }, - "com.amazonaws.cloudformation#LastUpdatedTime": { - "type": "timestamp" - }, - "com.amazonaws.cloudformation#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "LimitExceededException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#LimitName": { - "type": "string" - }, - "com.amazonaws.cloudformation#LimitValue": { - "type": "integer" - }, - "com.amazonaws.cloudformation#ListChangeSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ListChangeSetsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" - }, - "traits": { - "smithy.api#documentation": "Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the ListChangeSets action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ListChangeSetsOutput": { - "type": "structure", - "members": { - "Summaries": { - "target": "com.amazonaws.cloudformation#ChangeSetSummaries", - "traits": { - "smithy.api#documentation": "A list of ChangeSetSummary structures that provides the ID and status of each change set for the\n specified stack.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null.
The output for the ListChangeSets action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ListExports": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ListExportsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ListExportsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see \n CloudFormation export stack output values.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Exports" - } - } - }, - "com.amazonaws.cloudformation#ListExportsInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ListExportsOutput": { - "type": "structure", - "members": { - "Exports": { - "target": "com.amazonaws.cloudformation#Exports", - "traits": { - "smithy.api#documentation": "The output for the ListExports action.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ListImports": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ListImportsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ListImportsOutput" - }, - "traits": { - "smithy.api#documentation": "Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue\n function.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Imports" - } - } - }, - "com.amazonaws.cloudformation#ListImportsInput": { - "type": "structure", - "members": { - "ExportName": { - "target": "com.amazonaws.cloudformation#ExportName", - "traits": { - "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ListImportsOutput": { - "type": "structure", - "members": { - "Imports": { - "target": "com.amazonaws.cloudformation#Imports", - "traits": { - "smithy.api#documentation": "A list of stack names that are importing the specified exported output value.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this value is null.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ListStackInstanceResourceDrifts": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ListStackInstanceResourceDriftsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ListStackInstanceResourceDriftsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#OperationNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most\n recent drift detection operation. If an operation is in progress, it may only return\n partial results.
The name or unique ID of the stack set that you want to list drifted resources\n for.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The name of the Amazon Web Services account that you want to list resource drifts for.
", - "smithy.api#required": {} - } - }, - "StackInstanceRegion": { - "target": "com.amazonaws.cloudformation#Region", - "traits": { - "smithy.api#documentation": "The name of the Region where you want to list resource drifts.
", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique ID of the drift operation.
", - "smithy.api#required": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated\n administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in\n the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
\nA list of StackInstanceResourceDriftSummary structures that contain\n information about the specified stack instances.
If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
Returns summary information about stack instances that are associated with the specified stack set. You can\n filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that\n have a specific status.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Summaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudformation#ListStackInstancesInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to list stack instances for.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the previous request didn't return all the remaining results, the response's NextToken parameter\n value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign\n that token to the request object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The filter to apply to stack instances
" - } - }, - "StackInstanceAccount": { - "target": "com.amazonaws.cloudformation#Account", - "traits": { - "smithy.api#documentation": "The name of the Amazon Web Services account that you want to list stack instances for.
" - } - }, - "StackInstanceRegion": { - "target": "com.amazonaws.cloudformation#Region", - "traits": { - "smithy.api#documentation": "The name of the Region where you want to list stack instances.
" - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nA list of StackInstanceSummary structures that contain information about the specified stack\n instances.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StackResourceSummaries" - } - } - }, - "com.amazonaws.cloudformation#ListStackResourcesInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string that identifies the next page of stack resources that you want to retrieve.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the ListStackResource action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ListStackResourcesOutput": { - "type": "structure", - "members": { - "StackResourceSummaries": { - "target": "com.amazonaws.cloudformation#StackResourceSummaries", - "traits": { - "smithy.api#documentation": "A list of StackResourceSummary structures.
If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page\n exists, this value is null.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for a ListStackResources action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ListStackSetOperationResults": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ListStackSetOperationResultsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ListStackSetOperationResultsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#OperationNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Returns summary information about the results of a stack set operation.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Summaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudformation#ListStackSetOperationResultsInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to get operation results for.
", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The ID of the stack set operation.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe filter to apply to operation results.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ListStackSetOperationResultsOutput": { - "type": "structure", - "members": { - "Summaries": { - "target": "com.amazonaws.cloudformation#StackSetOperationResultSummaries", - "traits": { - "smithy.api#documentation": "A list of StackSetOperationResultSummary structures that contain information about the specified\n operation results, for accounts and Amazon Web Services Regions that are included in the operation.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
Returns summary information about operations performed on a stack set.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Summaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudformation#ListStackSetOperationsInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to get operation summaries for.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nA list of StackSetOperationSummary structures that contain summary information about operations for\n the specified stack set.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
Returns summary information about stack sets that are associated with the user.
\n[Self-managed permissions] If you set the CallAs parameter to SELF while signed in\n to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to SELF while signed\n in to the organization's management account, ListStackSets returns all stack sets in the\n management account.
[Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN\n while signed in to your member account, ListStackSets returns all stack sets with service-managed\n permissions in the management account.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The status of the stack sets that you want to get summary information about.
" - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nA list of StackSetSummary structures that contain information about the user's stack sets.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter\n is specified, summary information for all stacks is returned (including existing stacks and stacks that have been\n deleted).
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "StackSummaries" - } - } - }, - "com.amazonaws.cloudformation#ListStacksInput": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "A string that identifies the next page of stacks that you want to retrieve.
" - } - }, - "StackStatusFilter": { - "target": "com.amazonaws.cloudformation#StackStatusFilter", - "traits": { - "smithy.api#documentation": "Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
The input for ListStacks action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ListStacksOutput": { - "type": "structure", - "members": { - "StackSummaries": { - "target": "com.amazonaws.cloudformation#StackSummaries", - "traits": { - "smithy.api#documentation": "A list of StackSummary structures containing information about the specified stacks.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for ListStacks action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ListTypeRegistrations": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ListTypeRegistrationsInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ListTypeRegistrationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - } - ], - "traits": { - "smithy.api#documentation": "Returns a list of registration tokens for the specified extension(s).
", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudformation#ListTypeRegistrationsInput": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The current status of the extension registration request.
\nThe default is IN_PROGRESS.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
A list of extension registration tokens.
\nUse DescribeTypeRegistration to return detailed information about a type registration\n request.
" - } - }, - "NextToken": { - "target": "com.amazonaws.cloudformation#NextToken", - "traits": { - "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
Returns summary information about the versions of an extension.
", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudformation#ListTypeVersionsInput": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "The kind of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
The publisher ID of the extension publisher.
\nExtensions published by Amazon aren't assigned a publisher ID.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ListTypeVersionsOutput": { - "type": "structure", - "members": { - "TypeVersionSummaries": { - "target": "com.amazonaws.cloudformation#TypeVersionSummaries", - "traits": { - "smithy.api#documentation": "A list of TypeVersionSummary structures that contain information about the specified extension's\n versions.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns summary information about extension that have been registered with CloudFormation.
", - "smithy.api#idempotent": {}, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TypeSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.cloudformation#ListTypesInput": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.cloudformation#Visibility", - "traits": { - "smithy.api#documentation": "The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party\n publishers.
The default is PRIVATE.
For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type\n during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and\n therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
The deprecation status of the extension that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension is registered for use in CloudFormation operations.
\n DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
The type of extension.
" - } - }, - "Filters": { - "target": "com.amazonaws.cloudformation#TypeFilters", - "traits": { - "smithy.api#documentation": "Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
A list of TypeSummary structures that contain information about the specified extensions.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries\n to CloudWatch Logs.
", - "smithy.api#required": {} - } - }, - "LogGroupName": { - "target": "com.amazonaws.cloudformation#LogGroupName", - "traits": { - "smithy.api#documentation": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking\n the extension's handlers.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains logging configuration information for an extension.
" - } - }, - "com.amazonaws.cloudformation#LogicalIdHierarchy": { - "type": "string" - }, - "com.amazonaws.cloudformation#LogicalResourceId": { - "type": "string" - }, - "com.amazonaws.cloudformation#LogicalResourceIds": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#LogicalResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.cloudformation#MajorVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100000 - } - } - }, - "com.amazonaws.cloudformation#ManagedExecution": { - "type": "structure", - "members": { - "Active": { - "target": "com.amazonaws.cloudformation#ManagedExecutionNullable", - "traits": { - "smithy.api#documentation": "When true, StackSets performs non-conflicting operations concurrently and queues conflicting\n operations. After conflicting operations finish, StackSets starts queued operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations even if they are\n non-conflicting.
\nYou can't modify your stack set's execution configuration while there are running or queued operations for that\n stack set.
\nWhen false (default), StackSets performs one operation at a time in request order.
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" - } - }, - "com.amazonaws.cloudformation#ManagedExecutionNullable": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#MaxConcurrentCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.cloudformation#MaxConcurrentPercentage": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.cloudformation#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.cloudformation#Metadata": { - "type": "string" - }, - "com.amazonaws.cloudformation#ModuleInfo": { - "type": "structure", - "members": { - "TypeHierarchy": { - "target": "com.amazonaws.cloudformation#TypeHierarchy", - "traits": { - "smithy.api#documentation": "A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed\n starting with the inner-most nested module, and separated by /.
In the following example, the resource was created from a module, moduleA, that's nested inside a\n parent module, moduleB.
\n moduleA/moduleB\n
For more information, see Referencing resources in a module\n in the CloudFormation User Guide.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.
" - } - }, - "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 180 - } - } - }, - "com.amazonaws.cloudformation#NameAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "NameAlreadyExistsException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "The specified name is already in use.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cloudformation#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.cloudformation#NoEcho": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#NotificationARN": { - "type": "string" - }, - "com.amazonaws.cloudformation#NotificationARNs": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#NotificationARN" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.cloudformation#OnFailure": { - "type": "enum", - "members": { - "DO_NOTHING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOTHING" - } - }, - "ROLLBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - } - } - }, - "com.amazonaws.cloudformation#OnStackFailure": { - "type": "enum", - "members": { - "DO_NOTHING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOTHING" - } - }, - "ROLLBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - } - } - }, - "com.amazonaws.cloudformation#OperationIdAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OperationIdAlreadyExistsException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "The specified operation ID already exists.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cloudformation#OperationInProgressException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OperationInProgressException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "Another operation is currently in progress for this stack set. Only one operation can be performed for a stack\n set at a given time.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cloudformation#OperationNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "OperationNotFoundException", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified ID refers to an operation that doesn't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudformation#OperationResultFilter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudformation#OperationResultFilterName", - "traits": { - "smithy.api#documentation": "The type of filter to apply.
" - } - }, - "Values": { - "target": "com.amazonaws.cloudformation#OperationResultFilterValues", - "traits": { - "smithy.api#documentation": "The value to filter by.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The status that operation results are filtered by.
" - } - }, - "com.amazonaws.cloudformation#OperationResultFilterName": { - "type": "enum", - "members": { - "OPERATION_RESULT_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OPERATION_RESULT_STATUS" - } - } - } - }, - "com.amazonaws.cloudformation#OperationResultFilterValues": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 6, - "max": 9 - }, - "smithy.api#pattern": "^\\S{6,9}$" - } - }, - "com.amazonaws.cloudformation#OperationResultFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#OperationResultFilter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.cloudformation#OperationStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.cloudformation#OperationStatusCheckFailedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "ConditionalCheckFailed", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#OptionalSecureUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - } - } - }, - "com.amazonaws.cloudformation#OrganizationStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - }, - "DISABLED_PERMANENTLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED_PERMANENTLY" - } - } - } - }, - "com.amazonaws.cloudformation#OrganizationalUnitId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$" - } - }, - "com.amazonaws.cloudformation#OrganizationalUnitIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#OrganizationalUnitId" - } - }, - "com.amazonaws.cloudformation#Output": { - "type": "structure", - "members": { - "OutputKey": { - "target": "com.amazonaws.cloudformation#OutputKey", - "traits": { - "smithy.api#documentation": "The key associated with the output.
" - } - }, - "OutputValue": { - "target": "com.amazonaws.cloudformation#OutputValue", - "traits": { - "smithy.api#documentation": "The value associated with the output.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "User defined description associated with the output.
" - } - }, - "ExportName": { - "target": "com.amazonaws.cloudformation#ExportName", - "traits": { - "smithy.api#documentation": "The name of the export associated with the output.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Output data type.
" - } - }, - "com.amazonaws.cloudformation#OutputKey": { - "type": "string" - }, - "com.amazonaws.cloudformation#OutputValue": { - "type": "string" - }, - "com.amazonaws.cloudformation#Outputs": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Output" - } - }, - "com.amazonaws.cloudformation#Parameter": { - "type": "structure", - "members": { - "ParameterKey": { - "target": "com.amazonaws.cloudformation#ParameterKey", - "traits": { - "smithy.api#documentation": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.
" - } - }, - "ParameterValue": { - "target": "com.amazonaws.cloudformation#ParameterValue", - "traits": { - "smithy.api#documentation": "The input value associated with the parameter.
" - } - }, - "UsePreviousValue": { - "target": "com.amazonaws.cloudformation#UsePreviousValue", - "traits": { - "smithy.api#documentation": "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If\n you specify true, do not specify a parameter value.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The Parameter data type.
" - } - }, - "com.amazonaws.cloudformation#ParameterConstraints": { - "type": "structure", - "members": { - "AllowedValues": { - "target": "com.amazonaws.cloudformation#AllowedValues", - "traits": { - "smithy.api#documentation": "A list of values that are permitted for a parameter.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be\n defined in the stack template, CloudFormation returns only the AllowedValues property.
The name that's associated with the parameter.
" - } - }, - "DefaultValue": { - "target": "com.amazonaws.cloudformation#ParameterValue", - "traits": { - "smithy.api#documentation": "The default value of the parameter.
" - } - }, - "ParameterType": { - "target": "com.amazonaws.cloudformation#ParameterType", - "traits": { - "smithy.api#documentation": "The type of parameter.
" - } - }, - "NoEcho": { - "target": "com.amazonaws.cloudformation#NoEcho", - "traits": { - "smithy.api#documentation": "Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "The description that's associate with the parameter.
" - } - }, - "ParameterConstraints": { - "target": "com.amazonaws.cloudformation#ParameterConstraints", - "traits": { - "smithy.api#documentation": "The criteria that CloudFormation uses to validate parameter values.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The ParameterDeclaration data type.
" - } - }, - "com.amazonaws.cloudformation#ParameterDeclarations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#ParameterDeclaration" - } - }, - "com.amazonaws.cloudformation#ParameterKey": { - "type": "string" - }, - "com.amazonaws.cloudformation#ParameterType": { - "type": "string" - }, - "com.amazonaws.cloudformation#ParameterValue": { - "type": "string" - }, - "com.amazonaws.cloudformation#Parameters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Parameter" - } - }, - "com.amazonaws.cloudformation#PermissionModels": { - "type": "enum", - "members": { - "SERVICE_MANAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SERVICE_MANAGED" - } - }, - "SELF_MANAGED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELF_MANAGED" - } - } - } - }, - "com.amazonaws.cloudformation#PhysicalResourceId": { - "type": "string" - }, - "com.amazonaws.cloudformation#PhysicalResourceIdContext": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#PhysicalResourceIdContextKeyValuePair" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.cloudformation#PhysicalResourceIdContextKeyValuePair": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.cloudformation#Key", - "traits": { - "smithy.api#documentation": "The resource context key.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.cloudformation#Value", - "traits": { - "smithy.api#documentation": "The resource context value.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a resource that contains the targeted resource.
" - } - }, - "com.amazonaws.cloudformation#PrivateTypeArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+$" - } - }, - "com.amazonaws.cloudformation#Properties": { - "type": "string" - }, - "com.amazonaws.cloudformation#PropertyDifference": { - "type": "structure", - "members": { - "PropertyPath": { - "target": "com.amazonaws.cloudformation#PropertyPath", - "traits": { - "smithy.api#documentation": "The fully-qualified path to the resource property.
", - "smithy.api#required": {} - } - }, - "ExpectedValue": { - "target": "com.amazonaws.cloudformation#PropertyValue", - "traits": { - "smithy.api#documentation": "The expected property value of the resource property, as defined in the stack template and any values specified\n as template parameters.
", - "smithy.api#required": {} - } - }, - "ActualValue": { - "target": "com.amazonaws.cloudformation#PropertyValue", - "traits": { - "smithy.api#documentation": "The actual property value of the resource property.
", - "smithy.api#required": {} - } - }, - "DifferenceType": { - "target": "com.amazonaws.cloudformation#DifferenceType", - "traits": { - "smithy.api#documentation": "The type of property difference.
\n\n ADD: A value has been added to a resource property that's an array or list data type.
\n REMOVE: The property has been removed from the current resource configuration.
\n NOT_EQUAL: The current property value differs from its expected value (as defined in the stack\n template and any values specified as template parameters).
Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.\n Public extensions are available for use by all CloudFormation users. For more information about publishing\n extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI\n User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.
", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#PublishTypeInput": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#ThirdPartyType", - "traits": { - "smithy.api#documentation": "The type of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor\n version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
The Amazon Resource Name (ARN) assigned to the public extension upon publication.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#PublisherId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - }, - "smithy.api#pattern": "^[0-9a-zA-Z]{12,40}$" - } - }, - "com.amazonaws.cloudformation#PublisherName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.cloudformation#PublisherProfile": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^(http:|https:)+[^\\s]+[\\w]$" - } - }, - "com.amazonaws.cloudformation#PublisherStatus": { - "type": "enum", - "members": { - "VERIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERIFIED" - } - }, - "UNVERIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNVERIFIED" - } - } - } - }, - "com.amazonaws.cloudformation#Reason": { - "type": "string" - }, - "com.amazonaws.cloudformation#RecordHandlerProgress": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#RecordHandlerProgressInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#RecordHandlerProgressOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidStateTransitionException" - }, - { - "target": "com.amazonaws.cloudformation#OperationStatusCheckFailedException" - } - ], - "traits": { - "smithy.api#documentation": "Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't\n use this API in your code.
", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#RecordHandlerProgressInput": { - "type": "structure", - "members": { - "BearerToken": { - "target": "com.amazonaws.cloudformation#ClientToken", - "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", - "smithy.api#required": {} - } - }, - "OperationStatus": { - "target": "com.amazonaws.cloudformation#OperationStatus", - "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", - "smithy.api#required": {} - } - }, - "CurrentOperationStatus": { - "target": "com.amazonaws.cloudformation#OperationStatus", - "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" - } - }, - "StatusMessage": { - "target": "com.amazonaws.cloudformation#StatusMessage", - "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" - } - }, - "ErrorCode": { - "target": "com.amazonaws.cloudformation#HandlerErrorCode", - "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" - } - }, - "ResourceModel": { - "target": "com.amazonaws.cloudformation#ResourceModel", - "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#RecordHandlerProgressOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#Region": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9-]{1,128}$" - } - }, - "com.amazonaws.cloudformation#RegionConcurrencyType": { - "type": "enum", - "members": { - "SEQUENTIAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SEQUENTIAL" - } - }, - "PARALLEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARALLEL" - } - } - } - }, - "com.amazonaws.cloudformation#RegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Region" - } - }, - "com.amazonaws.cloudformation#RegisterPublisher": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#RegisterPublisherInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#RegisterPublisherOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - } - ], - "traits": { - "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public\n extensions are available for use by all CloudFormation users. This publisher ID applies to your account in\n all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
\n ", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#RegisterPublisherInput": { - "type": "structure", - "members": { - "AcceptTermsAndConditions": { - "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", - "traits": { - "smithy.api#documentation": "Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the\n terms and conditions in order to register to publish public extensions to the CloudFormation\n registry.
\nThe default is false.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#RegisterPublisherOutput": { - "type": "structure", - "members": { - "PublisherId": { - "target": "com.amazonaws.cloudformation#PublisherId", - "traits": { - "smithy.api#documentation": "The ID assigned this account by CloudFormation for publishing extensions.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#RegisterType": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#RegisterTypeInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#RegisterTypeOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - } - ], - "traits": { - "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for\n use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use SetTypeConfiguration to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#RegisterTypeInput": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "The kind of extension.
" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
A URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.
\nSpecifies logging configuration information for an extension.
" - } - }, - "ExecutionRoleArn": { - "target": "com.amazonaws.cloudformation#RoleARN2", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when\n invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust relationship\n with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more\n information about adding trust relationships, see Modifying a\n role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this\n execution role to create a temporary session token, which it then passes to the resource type handler, thereby\n supplying your resource type with the appropriate credentials.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#RequestToken", - "traits": { - "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same\n registration request, even if the request is submitted multiple times.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#RegisterTypeOutput": { - "type": "structure", - "members": { - "RegistrationToken": { - "target": "com.amazonaws.cloudformation#RegistrationToken", - "traits": { - "smithy.api#documentation": "The identifier for this registration request.
\nUse this registration token when calling DescribeTypeRegistration, which returns information\n about the status and IDs of the extension registration.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#RegistrationStatus": { - "type": "enum", - "members": { - "COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETE" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.cloudformation#RegistrationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" - } - }, - "com.amazonaws.cloudformation#RegistrationTokenList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#RegistrationToken" - } - }, - "com.amazonaws.cloudformation#RegistryType": { - "type": "enum", - "members": { - "RESOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE" - } - }, - "MODULE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODULE" - } - }, - "HOOK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOOK" - } - } - } - }, - "com.amazonaws.cloudformation#Replacement": { - "type": "enum", - "members": { - "True": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "True" - } - }, - "False": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "False" - } - }, - "Conditional": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Conditional" - } - } - } - }, - "com.amazonaws.cloudformation#RequestToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" - } - }, - "com.amazonaws.cloudformation#RequiredActivatedType": { - "type": "structure", - "members": { - "TypeNameAlias": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
" - } - }, - "OriginalTypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The type name of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
The publisher ID of the extension publisher.
" - } - }, - "SupportedMajorVersions": { - "target": "com.amazonaws.cloudformation#SupportedMajorVersions", - "traits": { - "smithy.api#documentation": "A list of the major versions of the extension type that the macro supports.
" - } - } - }, - "traits": { - "smithy.api#documentation": "For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.
\nFor more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.
" - } - }, - "com.amazonaws.cloudformation#RequiredActivatedTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#RequiredActivatedType" - } - }, - "com.amazonaws.cloudformation#RequiresRecreation": { - "type": "enum", - "members": { - "Never": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Never" - } - }, - "Conditionally": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Conditionally" - } - }, - "Always": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Always" - } - } - } - }, - "com.amazonaws.cloudformation#ResourceAttribute": { - "type": "enum", - "members": { - "Properties": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Properties" - } - }, - "Metadata": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Metadata" - } - }, - "CreationPolicy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreationPolicy" - } - }, - "UpdatePolicy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UpdatePolicy" - } - }, - "DeletionPolicy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeletionPolicy" - } - }, - "Tags": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Tags" - } - } - } - }, - "com.amazonaws.cloudformation#ResourceChange": { - "type": "structure", - "members": { - "Action": { - "target": "com.amazonaws.cloudformation#ChangeAction", - "traits": { - "smithy.api#documentation": "The action that CloudFormation takes on the resource, such as Add (adds a new resource),\n Modify (changes a resource), Remove (deletes a resource), Import (imports a\n resource), or Dynamic (exact action for the resource can't be determined).
The resource's logical ID, which is defined in the stack's template.
" - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they\n haven't been created.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "The type of CloudFormation resource, such as AWS::S3::Bucket.
For the Modify action, indicates whether CloudFormation will replace the resource by creating a\n new one and deleting the old one. This value depends on the value of the RequiresRecreation property in\n the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is\n Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.
For the Modify action, indicates which resource attribute is triggering this update, such as a\n change in the resource attribute's Metadata, Properties, or Tags.
For the Modify action, a list of ResourceChangeDetail structures that describes the\n changes that CloudFormation will make to the resource.
The change set ID of the nested change set.
" - } - }, - "ModuleInfo": { - "target": "com.amazonaws.cloudformation#ModuleInfo", - "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The ResourceChange structure describes the resource and the action that CloudFormation will\n perform on it if you execute this change set.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change\n and whether the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change\n before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will change, and its\n value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static\n evaluation.
For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
The group to which the CausingEntity value belongs. There are five entity groups:
\n ResourceReference entities are Ref intrinsic functions that refer to resources in the\n template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute\n values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the template.
\n Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as\n nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation\n sets the ChangeSource to Automatic because the nested stack's template might have\n changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the\n parent stack.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.
For a resource with Modify as the action, the ResourceChange structure describes the\n changes CloudFormation will make to that resource.
The template resource type of the target resources, such as AWS::S3::Bucket.
The logical IDs of the target resources of the specified ResourceType, as defined in the import\n template.
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources\n of that type.
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.
If the Attribute value is Properties, the name of the property. For all other\n attributes, the value is null.
If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
The field that CloudFormation will change, such as the name of a resource's property, and whether the\n resource will be recreated.
" - } - }, - "com.amazonaws.cloudformation#ResourceToImport": { - "type": "structure", - "members": { - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.
The logical ID of the target resource as specified in the template.
", - "smithy.api#required": {} - } - }, - "ResourceIdentifier": { - "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", - "traits": { - "smithy.api#documentation": "A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).
Describes the target resource of an import operation.
" - } - }, - "com.amazonaws.cloudformation#ResourceToSkip": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.cloudformation#ResourceType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.cloudformation#ResourceTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#ResourceType" - } - }, - "com.amazonaws.cloudformation#ResourcesToImport": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#ResourceToImport" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.cloudformation#ResourcesToSkip": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#ResourceToSkip" - } - }, - "com.amazonaws.cloudformation#RetainExceptOnCreate": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#RetainResources": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#LogicalResourceId" - } - }, - "com.amazonaws.cloudformation#RetainStacks": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.cloudformation#RetainStacksNullable": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#RetainStacksOnAccountRemovalNullable": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#RoleARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.cloudformation#RoleARN2": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^arn:.+:iam::[0-9]{12}:role/.+$" - } - }, - "com.amazonaws.cloudformation#RollbackConfiguration": { - "type": "structure", - "members": { - "RollbackTriggers": { - "target": "com.amazonaws.cloudformation#RollbackTriggers", - "traits": { - "smithy.api#documentation": "The triggers to monitor during stack creation or update actions.
\nBy default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update\n operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those\n triggers replace any list of triggers previously specified for the stack. This means:
\nTo use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
\nTo specify new or updated rollback triggers, you must specify all the triggers that you\n want used for this stack, even triggers you've specified before (for example, when creating the stack or during a\n previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied\n to the stack.
\nTo remove all currently specified triggers, specify an empty list for this parameter.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.
" - } - }, - "MonitoringTimeInMinutes": { - "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", - "traits": { - "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers\n after the stack creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits\n the specified period of time before cleaning up old resources after update operations. You can use this monitoring\n period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers\n during stack creation and update operations. Then, for update operations, it begins disposing of old resources\n immediately once the operation completes.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations,\n and for the specified monitoring period afterwards.
\nRollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and\n updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've\n specified. For more information, see Monitor and Roll Back Stack\n Operations.
" - } - }, - "com.amazonaws.cloudformation#RollbackStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#RollbackStackInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#RollbackStackOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
The name that's associated with the stack.
", - "smithy.api#required": {} - } - }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the\n stack.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A unique identifier for this RollbackStack request.
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
Unique identifier of the stack.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#RollbackTrigger": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rollback trigger.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.
", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.cloudformation#Type", - "traits": { - "smithy.api#documentation": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes\n to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
" - } - }, - "com.amazonaws.cloudformation#RollbackTriggers": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#RollbackTrigger" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.cloudformation#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.cloudformation#S3Url": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - } - } - }, - "com.amazonaws.cloudformation#Scope": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#ResourceAttribute" - } - }, - "com.amazonaws.cloudformation#SetStackPolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#SetStackPolicyInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Sets a stack policy for a specified stack.
" - } - }, - "com.amazonaws.cloudformation#SetStackPolicyInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name or unique stack ID that you want to associate a policy with.
", - "smithy.api#required": {} - } - }, - "StackPolicyBody": { - "target": "com.amazonaws.cloudformation#StackPolicyBody", - "traits": { - "smithy.api#documentation": "Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not both.
The input for the SetStackPolicy action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#SetTypeConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#SetTypeConfigurationInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#SetTypeConfigurationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#CFNRegistryException" - }, - { - "target": "com.amazonaws.cloudformation#TypeNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Specifies the configuration data for a registered CloudFormation extension, in the given account and\n Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of DescribeType. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User\n Guide.
\nThe Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.
" - } - }, - "Configuration": { - "target": "com.amazonaws.cloudformation#TypeConfiguration", - "traits": { - "smithy.api#documentation": "The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of DescribeType. For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
An alias by which to refer to this extension configuration data.
\nConditional: Specifying a configuration alias is required when setting a configuration for a resource type\n extension.
" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The name of the extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The type of extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.cloudformation#SetTypeDefaultVersionInput": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#PrivateTypeArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#SetTypeDefaultVersionOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#SignalResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#SignalResourceInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "traits": { - "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation\n doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout\n period is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
The stack name or unique stack ID that includes the resource that you want to signal.
", - "smithy.api#required": {} - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in\n the template.
", - "smithy.api#required": {} - } - }, - "UniqueId": { - "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", - "traits": { - "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as\n signaling a wait condition), each signal requires a different unique ID.
", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#ResourceSignalStatus", - "traits": { - "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes CloudFormation to\n immediately fail the stack creation or update.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The input for the SignalResource action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#Stack": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "Unique identifier of the stack.
" - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name associated with the stack.
", - "smithy.api#required": {} - } - }, - "ChangeSetId": { - "target": "com.amazonaws.cloudformation#ChangeSetId", - "traits": { - "smithy.api#documentation": "The unique ID of the change set.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "A user-defined description associated with the stack.
" - } - }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of Parameter structures.
The time at which the stack was created.
", - "smithy.api#required": {} - } - }, - "DeletionTime": { - "target": "com.amazonaws.cloudformation#DeletionTime", - "traits": { - "smithy.api#documentation": "The time the stack was deleted.
" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.cloudformation#LastUpdatedTime", - "traits": { - "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
" - } - }, - "RollbackConfiguration": { - "target": "com.amazonaws.cloudformation#RollbackConfiguration", - "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" - } - }, - "StackStatus": { - "target": "com.amazonaws.cloudformation#StackStatus", - "traits": { - "smithy.api#documentation": "Current status of the stack.
", - "smithy.api#required": {} - } - }, - "StackStatusReason": { - "target": "com.amazonaws.cloudformation#StackStatusReason", - "traits": { - "smithy.api#documentation": "Success/failure message associated with the stack status.
" - } - }, - "DisableRollback": { - "target": "com.amazonaws.cloudformation#DisableRollback", - "traits": { - "smithy.api#documentation": "Boolean to enable or disable rollback on stack creation failures:
\n\n true: disable rollback.
\n false: enable rollback.
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
" - } - }, - "TimeoutInMinutes": { - "target": "com.amazonaws.cloudformation#TimeoutMinutes", - "traits": { - "smithy.api#documentation": "The amount of time within which stack creation should complete.
" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "The capabilities allowed in the stack.
" - } - }, - "Outputs": { - "target": "com.amazonaws.cloudformation#Outputs", - "traits": { - "smithy.api#documentation": "A list of output structures.
" - } - }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the\n stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" - } - }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", - "traits": { - "smithy.api#documentation": "A list of Tags that specify information about the stack.
Whether termination protection is enabled for the stack.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.\n For more information, see Protecting a Stack From Being Deleted\n in the CloudFormation User Guide.
" - } - }, - "ParentId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" - } - }, - "RootId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" - } - }, - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackDriftInformation", - "traits": { - "smithy.api#documentation": "Information about whether a stack's actual configuration differs, or has drifted, from its\n expected configuration, as defined in the stack template and any values specified as template parameters. For more\n information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" - } - }, - "RetainExceptOnCreate": { - "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", - "traits": { - "smithy.api#documentation": "This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
The Stack data type.
" - } - }, - "com.amazonaws.cloudformation#StackDriftDetectionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.cloudformation#StackDriftDetectionStatus": { - "type": "enum", - "members": { - "DETECTION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DETECTION_IN_PROGRESS" - } - }, - "DETECTION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DETECTION_FAILED" - } - }, - "DETECTION_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DETECTION_COMPLETE" - } - } - } - }, - "com.amazonaws.cloudformation#StackDriftDetectionStatusReason": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackDriftInformation": { - "type": "structure", - "members": { - "StackDriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.
" - } - }, - "com.amazonaws.cloudformation#StackDriftInformationSummary": { - "type": "structure", - "members": { - "StackDriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.
" - } - }, - "com.amazonaws.cloudformation#StackDriftStatus": { - "type": "enum", - "members": { - "DRIFTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRIFTED" - } - }, - "IN_SYNC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_SYNC" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - }, - "NOT_CHECKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_CHECKED" - } - } - } - }, - "com.amazonaws.cloudformation#StackEvent": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The unique ID name of the instance of the stack.
", - "smithy.api#required": {} - } - }, - "EventId": { - "target": "com.amazonaws.cloudformation#EventId", - "traits": { - "smithy.api#documentation": "The unique ID of this event.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name associated with a stack.
", - "smithy.api#required": {} - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource specified in the template.
" - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The name or unique identifier associated with the physical instance of the resource.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
" - } - }, - "Timestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "Time the status was updated.
", - "smithy.api#required": {} - } - }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", - "traits": { - "smithy.api#documentation": "Current status of the resource.
" - } - }, - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", - "traits": { - "smithy.api#documentation": "Success/failure message associated with the resource.
" - } - }, - "ResourceProperties": { - "target": "com.amazonaws.cloudformation#ResourceProperties", - "traits": { - "smithy.api#documentation": "BLOB of the properties used to create the resource.
" - } - }, - "ClientRequestToken": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The name of the hook.
" - } - }, - "HookStatus": { - "target": "com.amazonaws.cloudformation#HookStatus", - "traits": { - "smithy.api#documentation": "Provides the status of the change set hook.
" - } - }, - "HookStatusReason": { - "target": "com.amazonaws.cloudformation#HookStatusReason", - "traits": { - "smithy.api#documentation": "Provides the reason for the hook status.
" - } - }, - "HookInvocationPoint": { - "target": "com.amazonaws.cloudformation#HookInvocationPoint", - "traits": { - "smithy.api#documentation": "Invocation points are points in provisioning logic where hooks are initiated.
" - } - }, - "HookFailureMode": { - "target": "com.amazonaws.cloudformation#HookFailureMode", - "traits": { - "smithy.api#documentation": "Specify the hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
The StackEvent data type.
" - } - }, - "com.amazonaws.cloudformation#StackEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackEvent" - } - }, - "com.amazonaws.cloudformation#StackId": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackId" - } - }, - "com.amazonaws.cloudformation#StackIdsUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5120 - }, - "smithy.api#pattern": "^(s3://|http(s?)://).+$" - } - }, - "com.amazonaws.cloudformation#StackInstance": { - "type": "structure", - "members": { - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that the stack instance is associated with.
" - } - }, - "Region": { - "target": "com.amazonaws.cloudformation#Region", - "traits": { - "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated with.
" - } - }, - "Account": { - "target": "com.amazonaws.cloudformation#Account", - "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The ID of the stack instance.
" - } - }, - "ParameterOverrides": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of parameters from the stack set template whose values have been overridden in this stack\n instance.
" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#StackInstanceStatus", - "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The detailed status of the stack instance.
" - } - }, - "StatusReason": { - "target": "com.amazonaws.cloudformation#Reason", - "traits": { - "smithy.api#documentation": "The explanation for the specific status code that's assigned to this stack instance.
" - } - }, - "OrganizationalUnitId": { - "target": "com.amazonaws.cloudformation#OrganizationalUnitId", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" - } - }, - "DriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This\n value will be NULL for any stack instance on which drift detection hasn't yet been performed.
The last unique ID of a StackSet operation performed on a stack instance.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack\n instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance\n can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is\n associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to\n the ID of the actual stack and the stack status.
" - } - }, - "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { - "type": "structure", - "members": { - "DetailedStatus": { - "target": "com.amazonaws.cloudformation#StackInstanceDetailedStatus", - "traits": { - "smithy.api#documentation": "\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the stack set operation\n fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be\n exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to start.
\n RUNNING: The operation in the specified account and Region is currently in progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped\n because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The detailed status of the stack instance.
" - } - }, - "com.amazonaws.cloudformation#StackInstanceDetailedStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "INOPERABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INOPERABLE" - } - }, - "SKIPPED_SUSPENDED_ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED_SUSPENDED_ACCOUNT" - } - } - } - }, - "com.amazonaws.cloudformation#StackInstanceFilter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.cloudformation#StackInstanceFilterName", - "traits": { - "smithy.api#documentation": "The type of filter to apply.
" - } - }, - "Values": { - "target": "com.amazonaws.cloudformation#StackInstanceFilterValues", - "traits": { - "smithy.api#documentation": "The status to filter by.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The filter to apply to stack instances
" - } - }, - "com.amazonaws.cloudformation#StackInstanceFilterName": { - "type": "enum", - "members": { - "DETAILED_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DETAILED_STATUS" - } - }, - "LAST_OPERATION_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST_OPERATION_ID" - } - }, - "DRIFT_STATUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRIFT_STATUS" - } - } - } - }, - "com.amazonaws.cloudformation#StackInstanceFilterValues": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^\\S{1,128}$" - } - }, - "com.amazonaws.cloudformation#StackInstanceFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackInstanceFilter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.cloudformation#StackInstanceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StackInstanceNotFoundException", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified stack instance doesn't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummary" - } - }, - "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummary": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The ID of the stack instance.
", - "smithy.api#required": {} - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource specified in the template.
", - "smithy.api#required": {} - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" - } - }, - "PhysicalResourceIdContext": { - "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", - "traits": { - "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough\n to uniquely identify that resource. Each context key-value pair specifies a unique resource\n that contains the targeted resource.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.
", - "smithy.api#required": {} - } - }, - "PropertyDifferences": { - "target": "com.amazonaws.cloudformation#PropertyDifferences", - "traits": { - "smithy.api#documentation": "Status of the actual configuration of the resource compared to its expected\n configuration. These will be present only for resources whose\n StackInstanceResourceDriftStatus is MODIFIED.
The drift status of the resource in a stack instance.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
Time at which the stack instance drift detection operation was initiated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The structure containing summary information about resource drifts for a stack\n instance.
" - } - }, - "com.amazonaws.cloudformation#StackInstanceStatus": { - "type": "enum", - "members": { - "CURRENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENT" - } - }, - "OUTDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTDATED" - } - }, - "INOPERABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INOPERABLE" - } - } - } - }, - "com.amazonaws.cloudformation#StackInstanceSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackInstanceSummary" - } - }, - "com.amazonaws.cloudformation#StackInstanceSummary": { - "type": "structure", - "members": { - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that the stack instance is associated with.
" - } - }, - "Region": { - "target": "com.amazonaws.cloudformation#Region", - "traits": { - "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated with.
" - } - }, - "Account": { - "target": "com.amazonaws.cloudformation#Account", - "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The ID of the stack instance.
" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#StackInstanceStatus", - "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The explanation for the specific status code assigned to this stack instance.
" - } - }, - "StackInstanceStatus": { - "target": "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus", - "traits": { - "smithy.api#documentation": "The detailed status of the stack instance.
" - } - }, - "OrganizationalUnitId": { - "target": "com.amazonaws.cloudformation#OrganizationalUnitId", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" - } - }, - "DriftStatus": { - "target": "com.amazonaws.cloudformation#StackDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This\n value will be NULL for any stack instance on which drift detection hasn't yet been performed.
The last unique ID of a StackSet operation performed on a stack instance.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structure that contains summary information about a stack instance.
" - } - }, - "com.amazonaws.cloudformation#StackName": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackNameOrId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)$" - } - }, - "com.amazonaws.cloudformation#StackNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StackNotFoundException", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudformation#StackPolicyBody": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16384 - } - } - }, - "com.amazonaws.cloudformation#StackPolicyDuringUpdateBody": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16384 - } - } - }, - "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1350 - } - } - }, - "com.amazonaws.cloudformation#StackPolicyURL": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1350 - } - } - }, - "com.amazonaws.cloudformation#StackResource": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name associated with the stack.
" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "Unique identifier of the stack.
" - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource specified in the template.
", - "smithy.api#required": {} - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", - "smithy.api#required": {} - } - }, - "Timestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "Time the status was updated.
", - "smithy.api#required": {} - } - }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", - "traits": { - "smithy.api#documentation": "Current status of the resource.
", - "smithy.api#required": {} - } - }, - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", - "traits": { - "smithy.api#documentation": "Success/failure message associated with the resource.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "User defined description associated with the resource.
" - } - }, - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", - "traits": { - "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" - } - }, - "ModuleInfo": { - "target": "com.amazonaws.cloudformation#ModuleInfo", - "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The StackResource data type.
" - } - }, - "com.amazonaws.cloudformation#StackResourceDetail": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name associated with the stack.
" - } - }, - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "Unique identifier of the stack.
" - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource specified in the template.
", - "smithy.api#required": {} - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", - "smithy.api#required": {} - } - }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "Time the status was updated.
", - "smithy.api#required": {} - } - }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", - "traits": { - "smithy.api#documentation": "Current status of the resource.
", - "smithy.api#required": {} - } - }, - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", - "traits": { - "smithy.api#documentation": "Success/failure message associated with the resource.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "User defined description associated with the resource.
" - } - }, - "Metadata": { - "target": "com.amazonaws.cloudformation#Metadata", - "traits": { - "smithy.api#documentation": "The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute\n in the CloudFormation User Guide.
Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" - } - }, - "ModuleInfo": { - "target": "com.amazonaws.cloudformation#ModuleInfo", - "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains detailed information about the specified stack resource.
" - } - }, - "com.amazonaws.cloudformation#StackResourceDrift": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The ID of the stack.
", - "smithy.api#required": {} - } - }, - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource specified in the template.
", - "smithy.api#required": {} - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by\n CloudFormation.
" - } - }, - "PhysicalResourceIdContext": { - "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", - "traits": { - "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a unique resource that contains the targeted resource.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "The type of the resource.
", - "smithy.api#required": {} - } - }, - "ExpectedProperties": { - "target": "com.amazonaws.cloudformation#Properties", - "traits": { - "smithy.api#documentation": "A JSON structure containing the expected property values of the stack resource, as defined in the stack template\n and any values specified as template parameters.
\nFor resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.
A JSON structure containing the actual property values of the stack resource.
\nFor resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.
A collection of the resource properties whose actual values differ from their expected values. These will be\n present only for resources whose StackResourceDriftStatus is\n MODIFIED.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected template configuration because the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected values (as defined in the\n stack template and any values specified as template parameters).
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
Time at which CloudFormation performed drift detection on the stack resource.
", - "smithy.api#required": {} - } - }, - "ModuleInfo": { - "target": "com.amazonaws.cloudformation#ModuleInfo", - "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nResources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" - } - }, - "com.amazonaws.cloudformation#StackResourceDriftInformation": { - "type": "structure", - "members": { - "StackResourceDriftStatus": { - "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
When CloudFormation last checked if the resource had drifted from its expected configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" - } - }, - "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { - "type": "structure", - "members": { - "StackResourceDriftStatus": { - "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.
Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any\n resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more\n information about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
When CloudFormation last checked if the resource had drifted from its expected configuration.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" - } - }, - "com.amazonaws.cloudformation#StackResourceDriftStatus": { - "type": "enum", - "members": { - "IN_SYNC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_SYNC" - } - }, - "MODIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODIFIED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "NOT_CHECKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_CHECKED" - } - } - } - }, - "com.amazonaws.cloudformation#StackResourceDriftStatusFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackResourceDriftStatus" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.cloudformation#StackResourceDrifts": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackResourceDrift" - } - }, - "com.amazonaws.cloudformation#StackResourceSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackResourceSummary" - } - }, - "com.amazonaws.cloudformation#StackResourceSummary": { - "type": "structure", - "members": { - "LogicalResourceId": { - "target": "com.amazonaws.cloudformation#LogicalResourceId", - "traits": { - "smithy.api#documentation": "The logical name of the resource specified in the template.
", - "smithy.api#required": {} - } - }, - "PhysicalResourceId": { - "target": "com.amazonaws.cloudformation#PhysicalResourceId", - "traits": { - "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of the resource.
" - } - }, - "ResourceType": { - "target": "com.amazonaws.cloudformation#ResourceType", - "traits": { - "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
", - "smithy.api#required": {} - } - }, - "LastUpdatedTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "Time the status was updated.
", - "smithy.api#required": {} - } - }, - "ResourceStatus": { - "target": "com.amazonaws.cloudformation#ResourceStatus", - "traits": { - "smithy.api#documentation": "Current status of the resource.
", - "smithy.api#required": {} - } - }, - "ResourceStatusReason": { - "target": "com.amazonaws.cloudformation#ResourceStatusReason", - "traits": { - "smithy.api#documentation": "Success/failure message associated with the resource.
" - } - }, - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackResourceDriftInformationSummary", - "traits": { - "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" - } - }, - "ModuleInfo": { - "target": "com.amazonaws.cloudformation#ModuleInfo", - "traits": { - "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains high-level information about the specified stack resource.
" - } - }, - "com.amazonaws.cloudformation#StackResources": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackResource" - } - }, - "com.amazonaws.cloudformation#StackSet": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name that's associated with the stack set.
" - } - }, - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "The ID of the stack set.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#StackSetStatus", - "traits": { - "smithy.api#documentation": "The status of the stack set.
" - } - }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update the stack set.
" - } - }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of input parameters for a stack set.
" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM\n Resources in CloudFormation Templates.\n
" - } - }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", - "traits": { - "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50 tags can be\n specified.
" - } - }, - "StackSetARN": { - "target": "com.amazonaws.cloudformation#StackSetARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stack set.
" - } - }, - "AdministrationRoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations\n in the CloudFormation User Guide.
" - } - }, - "ExecutionRoleName": { - "target": "com.amazonaws.cloudformation#ExecutionRoleName", - "traits": { - "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" - } - }, - "StackSetDriftDetectionDetails": { - "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", - "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations currently in progress isn't included.
" - } - }, - "AutoDeployment": { - "target": "com.amazonaws.cloudformation#AutoDeployment", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" - } - }, - "PermissionModel": { - "target": "com.amazonaws.cloudformation#PermissionModels", - "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" - } - }, - "ManagedExecution": { - "target": "com.amazonaws.cloudformation#ManagedExecution", - "traits": { - "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" - } - }, - "Regions": { - "target": "com.amazonaws.cloudformation#RegionList", - "traits": { - "smithy.api#documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to provision stacks into\n Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set,\n you specify the template to use, in addition to any parameters and capabilities that the template requires.
" - } - }, - "com.amazonaws.cloudformation#StackSetARN": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackSetDriftDetectionDetails": { - "type": "structure", - "members": { - "DriftStatus": { - "target": "com.amazonaws.cloudformation#StackSetDriftStatus", - "traits": { - "smithy.api#documentation": "Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
The status of the stack set drift detection operation.
\n\n COMPLETED: The drift detection operation completed without failing on any stack instances.
\n FAILED: The drift detection operation exceeded the specified failure tolerance.
\n PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance\n for the operation.
\n IN_PROGRESS: The drift detection operation is currently being performed.
\n STOPPED: The user has canceled the drift detection operation.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value\n will be NULL for any stack set on which drift detection hasn't yet been performed.
The total number of stack instances belonging to this stack set.
\nThe total number of stack instances is equal to the total of:
\nStack instances that match the stack set configuration.
\nStack instances that have drifted from the stack set configuration.
\nStack instances where the drift detection operation has failed.
\nStack instances currently being checked for drift.
\nThe number of stack instances that have drifted from the expected template and parameter configuration of the\n stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack\n don't match their expected configuration.
" - } - }, - "InSyncStackInstancesCount": { - "target": "com.amazonaws.cloudformation#InSyncStackInstancesCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of stack instances which match the expected template and parameter configuration of the stack\n set.
" - } - }, - "InProgressStackInstancesCount": { - "target": "com.amazonaws.cloudformation#InProgressStackInstancesCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of stack instances that are currently being checked for drift.
" - } - }, - "FailedStackInstancesCount": { - "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of stack instances for which the drift detection operation failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations in-progress isn't included.
\nFor stack set operations, includes information about drift operations currently being performed on the stack\n set.
\nFor more information, see Detecting unmanaged changes in stack sets in\n the CloudFormation User Guide.
" - } - }, - "com.amazonaws.cloudformation#StackSetDriftDetectionStatus": { - "type": "enum", - "members": { - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "PARTIAL_SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTIAL_SUCCESS" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.cloudformation#StackSetDriftStatus": { - "type": "enum", - "members": { - "DRIFTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRIFTED" - } - }, - "IN_SYNC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_SYNC" - } - }, - "NOT_CHECKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_CHECKED" - } - } - } - }, - "com.amazonaws.cloudformation#StackSetId": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackSetName": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackSetNameOrId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?$" - } - }, - "com.amazonaws.cloudformation#StackSetNotEmptyException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StackSetNotEmptyException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack\n instances from the stack set before deleting the stack set.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cloudformation#StackSetNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StackSetNotFoundException", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified stack set doesn't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudformation#StackSetOperation": { - "type": "structure", - "members": { - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique ID of a stack set operation.
" - } - }, - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "The ID of the stack set.
" - } - }, - "Action": { - "target": "com.amazonaws.cloudformation#StackSetOperationAction", - "traits": { - "smithy.api#documentation": "The type of stack set operation: CREATE, UPDATE, or DELETE. Create and\n delete operations affect only the specified stack set instances that are associated with the specified stack set.\n Update operations affect both the stack set itself, in addition to all associated stack set\n instances.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The preferences for how CloudFormation performs this stack set operation.
" - } - }, - "RetainStacks": { - "target": "com.amazonaws.cloudformation#RetainStacksNullable", - "traits": { - "smithy.api#documentation": "For stack set operations of action type DELETE, specifies whether to remove the stack instances\n from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an\n existing, saved stack to a new stack set.
The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple Administrators in the\n CloudFormation User Guide.
" - } - }, - "ExecutionRoleName": { - "target": "com.amazonaws.cloudformation#ExecutionRoleName", - "traits": { - "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" - } - }, - "CreationTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to\n perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.
" - } - }, - "EndTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" - } - }, - "DeploymentTargets": { - "target": "com.amazonaws.cloudformation#DeploymentTargets", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts affected by the stack operation.
" - } - }, - "StackSetDriftDetectionDetails": { - "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", - "traits": { - "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in\n the CloudFormation User Guide.
" - } - }, - "StatusReason": { - "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", - "traits": { - "smithy.api#documentation": "The status of the operation in details.
" - } - }, - "StatusDetails": { - "target": "com.amazonaws.cloudformation#StackSetOperationStatusDetails", - "traits": { - "smithy.api#documentation": "Detailed information about the StackSet operation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structure that contains information about a stack set operation.
" - } - }, - "com.amazonaws.cloudformation#StackSetOperationAction": { - "type": "enum", - "members": { - "CREATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE" - } - }, - "UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - }, - "DETECT_DRIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DETECT_DRIFT" - } - } - } - }, - "com.amazonaws.cloudformation#StackSetOperationPreferences": { - "type": "structure", - "members": { - "RegionConcurrencyType": { - "target": "com.amazonaws.cloudformation#RegionConcurrencyType", - "traits": { - "smithy.api#documentation": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a\n time.
" - } - }, - "RegionOrder": { - "target": "com.amazonaws.cloudformation#RegionList", - "traits": { - "smithy.api#documentation": "The order of the Regions where you want to perform the stack operation.
" - } - }, - "FailureToleranceCount": { - "target": "com.amazonaws.cloudformation#FailureToleranceCount", - "traits": { - "smithy.api#documentation": "The number of accounts, per Region, for which this operation can fail before CloudFormation stops the\n operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation\n in any subsequent Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops\n the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the\n operation in any subsequent Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of\n FailureToleranceCount.MaxConcurrentCount is at most one more than the\n FailureToleranceCount.
Note that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to\n the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
\nNote that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" - } - }, - "com.amazonaws.cloudformation#StackSetOperationResultStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.cloudformation#StackSetOperationResultSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackSetOperationResultSummary" - } - }, - "com.amazonaws.cloudformation#StackSetOperationResultSummary": { - "type": "structure", - "members": { - "Account": { - "target": "com.amazonaws.cloudformation#Account", - "traits": { - "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
" - } - }, - "Region": { - "target": "com.amazonaws.cloudformation#Region", - "traits": { - "smithy.api#documentation": "The name of the Amazon Web Services Region for this operation result.
" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", - "traits": { - "smithy.api#documentation": "The result status of the stack set operation for the given account in the given Region.
\n\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed.
If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set\n operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is currently in progress.
\n PENDING: The operation in the specified account and Region has yet to start.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The reason for the assigned result status.
" - } - }, - "AccountGateResult": { - "target": "com.amazonaws.cloudformation#AccountGateResult", - "traits": { - "smithy.api#documentation": "The results of the account gate function CloudFormation invokes, if present, before proceeding with stack\n set operations in an account.
" - } - }, - "OrganizationalUnitId": { - "target": "com.amazonaws.cloudformation#OrganizationalUnitId", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structure that contains information about a specified operation's results for a given account in a given\n Region.
" - } - }, - "com.amazonaws.cloudformation#StackSetOperationStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "SUCCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCEEDED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "STOPPING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPING" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - }, - "QUEUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED" - } - } - } - }, - "com.amazonaws.cloudformation#StackSetOperationStatusDetails": { - "type": "structure", - "members": { - "FailedStackInstancesCount": { - "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The number of stack instances for which the StackSet operation failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Detailed information about the StackSet operation.
" - } - }, - "com.amazonaws.cloudformation#StackSetOperationStatusReason": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackSetOperationSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackSetOperationSummary" - } - }, - "com.amazonaws.cloudformation#StackSetOperationSummary": { - "type": "structure", - "members": { - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique ID of the stack set operation.
" - } - }, - "Action": { - "target": "com.amazonaws.cloudformation#StackSetOperationAction", - "traits": { - "smithy.api#documentation": "The type of operation: CREATE, UPDATE, or DELETE. Create and delete\n operations affect only the specified stack instances that are associated with the specified stack set. Update\n operations affect both the stack set itself and all associated stack set instances.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to\n perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.
" - } - }, - "EndTimestamp": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" - } - }, - "StatusReason": { - "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", - "traits": { - "smithy.api#documentation": "The status of the operation in details.
" - } - }, - "StatusDetails": { - "target": "com.amazonaws.cloudformation#StackSetOperationStatusDetails", - "traits": { - "smithy.api#documentation": "Detailed information about the stack set operation.
" - } - }, - "OperationPreferences": { - "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", - "traits": { - "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structures that contain summary information about the specified operation.
" - } - }, - "com.amazonaws.cloudformation#StackSetStatus": { - "type": "enum", - "members": { - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.cloudformation#StackSetSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackSetSummary" - } - }, - "com.amazonaws.cloudformation#StackSetSummary": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name of the stack set.
" - } - }, - "StackSetId": { - "target": "com.amazonaws.cloudformation#StackSetId", - "traits": { - "smithy.api#documentation": "The ID of the stack set.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" - } - }, - "Status": { - "target": "com.amazonaws.cloudformation#StackSetStatus", - "traits": { - "smithy.api#documentation": "The status of the stack set.
" - } - }, - "AutoDeployment": { - "target": "com.amazonaws.cloudformation#AutoDeployment", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organizational unit (OU).
" - } - }, - "PermissionModel": { - "target": "com.amazonaws.cloudformation#PermissionModels", - "traits": { - "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value\n will be NULL for any stack set on which drift detection hasn't yet been performed.
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The structures that contain summary information about the specified stack set.
" - } - }, - "com.amazonaws.cloudformation#StackStatus": { - "type": "enum", - "members": { - "CREATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_IN_PROGRESS" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "CREATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_COMPLETE" - } - }, - "ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" - } - }, - "ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_FAILED" - } - }, - "ROLLBACK_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK_COMPLETE" - } - }, - "DELETE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_IN_PROGRESS" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - }, - "DELETE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_COMPLETE" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" - } - }, - "UPDATE_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_COMPLETE" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "UPDATE_ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_ROLLBACK_IN_PROGRESS" - } - }, - "UPDATE_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_ROLLBACK_FAILED" - } - }, - "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" - } - }, - "UPDATE_ROLLBACK_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_ROLLBACK_COMPLETE" - } - }, - "REVIEW_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REVIEW_IN_PROGRESS" - } - }, - "IMPORT_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_IN_PROGRESS" - } - }, - "IMPORT_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_COMPLETE" - } - }, - "IMPORT_ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_ROLLBACK_IN_PROGRESS" - } - }, - "IMPORT_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_ROLLBACK_FAILED" - } - }, - "IMPORT_ROLLBACK_COMPLETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_ROLLBACK_COMPLETE" - } - } - } - }, - "com.amazonaws.cloudformation#StackStatusFilter": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackStatus" - } - }, - "com.amazonaws.cloudformation#StackStatusReason": { - "type": "string" - }, - "com.amazonaws.cloudformation#StackSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#StackSummary" - } - }, - "com.amazonaws.cloudformation#StackSummary": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "Unique stack identifier.
" - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name associated with the stack.
", - "smithy.api#required": {} - } - }, - "TemplateDescription": { - "target": "com.amazonaws.cloudformation#TemplateDescription", - "traits": { - "smithy.api#documentation": "The template description of the template used to create the stack.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.cloudformation#CreationTime", - "traits": { - "smithy.api#documentation": "The time the stack was created.
", - "smithy.api#required": {} - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.cloudformation#LastUpdatedTime", - "traits": { - "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
" - } - }, - "DeletionTime": { - "target": "com.amazonaws.cloudformation#DeletionTime", - "traits": { - "smithy.api#documentation": "The time the stack was deleted.
" - } - }, - "StackStatus": { - "target": "com.amazonaws.cloudformation#StackStatus", - "traits": { - "smithy.api#documentation": "The current status of the stack.
", - "smithy.api#required": {} - } - }, - "StackStatusReason": { - "target": "com.amazonaws.cloudformation#StackStatusReason", - "traits": { - "smithy.api#documentation": "Success/Failure message associated with the stack status.
" - } - }, - "ParentId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" - } - }, - "RootId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" - } - }, - "DriftInformation": { - "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", - "traits": { - "smithy.api#documentation": "Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The StackSummary Data Type
" - } - }, - "com.amazonaws.cloudformation#Stacks": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Stack" - } - }, - "com.amazonaws.cloudformation#StageList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TemplateStage" - } - }, - "com.amazonaws.cloudformation#StaleRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "StaleRequestException", - "httpResponseCode": 409 - }, - "smithy.api#documentation": "Another operation has been performed on this stack set since the specified operation was performed.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.cloudformation#StatusMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.cloudformation#StopStackSetOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#StopStackSetOperationInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#StopStackSetOperationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the\n unstarted stack instance deployments and wait for those are in-progress to complete.
" - } - }, - "com.amazonaws.cloudformation#StopStackSetOperationInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to stop the operation for.
", - "smithy.api#required": {} - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The ID of the stack operation.
", - "smithy.api#required": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\n\n Required. A string used to identify this tag. You can specify a maximum of 128 characters for a\n tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.
\n Required. A string containing the value for this tag. You can specify a maximum of 256\n characters for a tag value.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
" - } - }, - "com.amazonaws.cloudformation#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.cloudformation#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.cloudformation#Tags": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.cloudformation#TemplateBody": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudformation#TemplateDescription": { - "type": "string" - }, - "com.amazonaws.cloudformation#TemplateParameter": { - "type": "structure", - "members": { - "ParameterKey": { - "target": "com.amazonaws.cloudformation#ParameterKey", - "traits": { - "smithy.api#documentation": "The name associated with the parameter.
" - } - }, - "DefaultValue": { - "target": "com.amazonaws.cloudformation#ParameterValue", - "traits": { - "smithy.api#documentation": "The default value associated with the parameter.
" - } - }, - "NoEcho": { - "target": "com.amazonaws.cloudformation#NoEcho", - "traits": { - "smithy.api#documentation": "Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "User defined description associated with the parameter.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The TemplateParameter data type.
" - } - }, - "com.amazonaws.cloudformation#TemplateParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TemplateParameter" - } - }, - "com.amazonaws.cloudformation#TemplateStage": { - "type": "enum", - "members": { - "Original": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Original" - } - }, - "Processed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Processed" - } - } - } - }, - "com.amazonaws.cloudformation#TemplateSummaryConfig": { - "type": "structure", - "members": { - "TreatUnrecognizedResourceTypesAsWarnings": { - "target": "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings", - "traits": { - "smithy.api#documentation": "If set to True, any unrecognized resource types generate warnings and not an error. Any\n unrecognized resource types are returned in the Warnings output parameter.
Options for the GetTemplateSummary API action.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your\n account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered.\n For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into DescribeType to monitor the current test\n status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The type of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this\n account and Region for testing.
" - } - }, - "LogDeliveryBucket": { - "target": "com.amazonaws.cloudformation#S3Bucket", - "traits": { - "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been\n assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#TestTypeOutput": { - "type": "structure", - "members": { - "TypeVersionArn": { - "target": "com.amazonaws.cloudformation#TypeArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#ThirdPartyType": { - "type": "enum", - "members": { - "RESOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE" - } - }, - "MODULE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODULE" - } - }, - "HOOK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOOK" - } - } - } - }, - "com.amazonaws.cloudformation#ThirdPartyTypeArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}::type/.+/[0-9a-zA-Z]{12,40}/.+$" - } - }, - "com.amazonaws.cloudformation#TimeoutMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.cloudformation#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.cloudformation#TokenAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TokenAlreadyExistsException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "A client request token already exists.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.cloudformation#TotalStackInstancesCount": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.cloudformation#TransformName": { - "type": "string" - }, - "com.amazonaws.cloudformation#TransformsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TransformName" - } - }, - "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#Type": { - "type": "string" - }, - "com.amazonaws.cloudformation#TypeArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+$" - } - }, - "com.amazonaws.cloudformation#TypeConfiguration": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 204800 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.cloudformation#TypeConfigurationAlias": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}$" - } - }, - "com.amazonaws.cloudformation#TypeConfigurationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type-configuration/.+$" - } - }, - "com.amazonaws.cloudformation#TypeConfigurationDetails": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.cloudformation#TypeConfigurationArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
" - } - }, - "Alias": { - "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", - "traits": { - "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was set.
" - } - }, - "Configuration": { - "target": "com.amazonaws.cloudformation#TypeConfiguration", - "traits": { - "smithy.api#documentation": "A JSON string specifying the configuration data for the extension, in this account and Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n {}.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n null.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The name of the extension.
" - } - }, - "IsDefaultConfiguration": { - "target": "com.amazonaws.cloudformation#IsDefaultConfiguration", - "traits": { - "smithy.api#documentation": "Whether this configuration data is the default configuration for the extension.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" - } - }, - "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TypeConfigurationDetails" - } - }, - "com.amazonaws.cloudformation#TypeConfigurationIdentifier": { - "type": "structure", - "members": { - "TypeArn": { - "target": "com.amazonaws.cloudformation#TypeArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" - } - }, - "TypeConfigurationAlias": { - "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", - "traits": { - "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was set.
" - } - }, - "TypeConfigurationArn": { - "target": "com.amazonaws.cloudformation#TypeConfigurationArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the configuration, in this account and Region.
" - } - }, - "Type": { - "target": "com.amazonaws.cloudformation#ThirdPartyType", - "traits": { - "smithy.api#documentation": "The type of extension.
" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The name of the extension type to which this configuration applies.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Identifying information for the configuration of a CloudFormation extension.
" - } - }, - "com.amazonaws.cloudformation#TypeConfigurationIdentifiers": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.cloudformation#TypeConfigurationNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage", - "traits": { - "smithy.api#documentation": "An message with details about the error that occurred.
" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TypeConfigurationNotFoundException", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified extension configuration can't be found.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudformation#TypeFilters": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.cloudformation#Category", - "traits": { - "smithy.api#documentation": "The category of extensions to return.
\n\n REGISTERED: Private extensions that have been registered for this account and Region.
\n ACTIVATED: Public extensions that have been activated for this account and Region.
\n THIRD_PARTY: Extensions available for use from publishers other than Amazon. This\n includes:
Private extensions registered in the account.
\nPublic extensions from publishers other than Amazon, whether activated or not.
\n\n AWS_TYPES: Extensions available for use from Amazon.
The id of the publisher of the extension.
\nExtensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES category to\n specify a list of types published by Amazon.
A prefix to use as a filter for results.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Filter criteria to use in determining which extensions to return.
" - } - }, - "com.amazonaws.cloudformation#TypeHierarchy": { - "type": "string" - }, - "com.amazonaws.cloudformation#TypeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 204 - }, - "smithy.api#pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}$" - } - }, - "com.amazonaws.cloudformation#TypeNamePrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 204 - }, - "smithy.api#pattern": "^([A-Za-z0-9]{2,64}::){0,2}([A-Za-z0-9]{2,64}:?){0,1}$" - } - }, - "com.amazonaws.cloudformation#TypeNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudformation#ErrorMessage", - "traits": { - "smithy.api#documentation": "An message with details about the error that occurred.
" - } - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "TypeNotFoundException", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The specified extension doesn't exist in the CloudFormation registry.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.cloudformation#TypeSchema": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16777216 - } - } - }, - "com.amazonaws.cloudformation#TypeSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TypeSummary" - } - }, - "com.amazonaws.cloudformation#TypeSummary": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "The kind of extension.
" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The name of the extension.
\nIf you specified a TypeNameAlias when you activate this extension in your account\n and Region, CloudFormation considers that alias as the type name.
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more\n information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" - } - }, - "TypeArn": { - "target": "com.amazonaws.cloudformation#TypeArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" - } - }, - "LastUpdated": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nFor all other extension types, CloudFormation returns null.
The description of the extension.
" - } - }, - "PublisherId": { - "target": "com.amazonaws.cloudformation#PublisherId", - "traits": { - "smithy.api#documentation": "The ID of the extension publisher, if the extension is published by a third party. Extensions published by\n Amazon don't return a publisher ID.
" - } - }, - "OriginalTypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
The service used to verify the publisher identity.
\nFor more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension\n Development.
" - } - }, - "PublisherName": { - "target": "com.amazonaws.cloudformation#PublisherName", - "traits": { - "smithy.api#documentation": "The publisher name, as defined in the public profile for that publisher in the service used to verify the\n publisher identity.
" - } - }, - "IsActivated": { - "target": "com.amazonaws.cloudformation#IsActivated", - "traits": { - "smithy.api#documentation": "Whether the extension is activated for this account and Region.
\nThis applies only to third-party public extensions. Extensions published by Amazon are activated by\n default.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains summary information about the specified CloudFormation extension.
" - } - }, - "com.amazonaws.cloudformation#TypeTestsStatus": { - "type": "enum", - "members": { - "PASSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "NOT_TESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_TESTED" - } - } - } - }, - "com.amazonaws.cloudformation#TypeTestsStatusDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\s\\S]+$" - } - }, - "com.amazonaws.cloudformation#TypeVersionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Za-z0-9-]+$" - } - }, - "com.amazonaws.cloudformation#TypeVersionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TypeVersionSummary" - } - }, - "com.amazonaws.cloudformation#TypeVersionSummary": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.cloudformation#RegistryType", - "traits": { - "smithy.api#documentation": "The kind of extension.
" - } - }, - "TypeName": { - "target": "com.amazonaws.cloudformation#TypeName", - "traits": { - "smithy.api#documentation": "The name of the extension.
" - } - }, - "VersionId": { - "target": "com.amazonaws.cloudformation#TypeVersionId", - "traits": { - "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it's registered.
" - } - }, - "IsDefaultVersion": { - "target": "com.amazonaws.cloudformation#IsDefaultVersion", - "traits": { - "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon.\n For public third-party extensions, CloudFormation returns null.
The Amazon Resource Name (ARN) of the extension version.
" - } - }, - "TimeCreated": { - "target": "com.amazonaws.cloudformation#Timestamp", - "traits": { - "smithy.api#documentation": "When the version was registered.
" - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "The description of the extension version.
" - } - }, - "PublicVersionNumber": { - "target": "com.amazonaws.cloudformation#PublicVersionNumber", - "traits": { - "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated\n third-arty extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
Contains summary information about a specific version of a CloudFormation extension.
" - } - }, - "com.amazonaws.cloudformation#UnprocessedTypeConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" - } - }, - "com.amazonaws.cloudformation#UpdateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#UpdateStackInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#UpdateStackOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" - }, - { - "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" - } - ], - "traits": { - "smithy.api#documentation": "Updates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack through the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate\n action.
\nFor more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.
" - } - }, - "com.amazonaws.cloudformation#UpdateStackInput": { - "type": "structure", - "members": { - "StackName": { - "target": "com.amazonaws.cloudformation#StackName", - "traits": { - "smithy.api#documentation": "The name or unique stack ID of the stack to update.
", - "smithy.api#required": {} - } - }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" - } - }, - "StackPolicyDuringUpdateURL": { - "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", - "traits": { - "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" - } - }, - "Parameters": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros to Perform Custom\n Processing on Templates.
\nThe template resource types that you have permissions to work with for this update stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
" - } - }, - "RoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" - } - }, - "RollbackConfiguration": { - "target": "com.amazonaws.cloudformation#RollbackConfiguration", - "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" - } - }, - "StackPolicyBody": { - "target": "com.amazonaws.cloudformation#StackPolicyBody", - "traits": { - "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" - } - }, - "StackPolicyURL": { - "target": "com.amazonaws.cloudformation#StackPolicyURL", - "traits": { - "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" - } - }, - "NotificationARNs": { - "target": "com.amazonaws.cloudformation#NotificationARNs", - "traits": { - "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates\n with the stack. Specify an empty list to remove all notification topics.
" - } - }, - "Tags": { - "target": "com.amazonaws.cloudformation#Tags", - "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported\n resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an\n empty value, CloudFormation removes all associated tags.
" - } - }, - "DisableRollback": { - "target": "com.amazonaws.cloudformation#DisableRollback", - "traits": { - "smithy.api#documentation": "Preserve the state of previously provisioned resources when an operation fails.
\nDefault: False\n
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
This deletion policy deletes newly created resources, but retains existing resources, when a stack operation is\n rolled back. This ensures new, empty, and unused resources are deleted, while critical resources and their data are\n retained. RetainExceptOnCreate can be specified for any resource that supports the\n \n DeletionPolicy attribute.
The input for an UpdateStack action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#UpdateStackInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#UpdateStackInstancesInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#UpdateStackInstancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudformation#OperationInProgressException" - }, - { - "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StaleRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use UpdateStackSet to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
The name or unique ID of the stack set associated with the stack instances.
", - "smithy.api#required": {} - } - }, - "Accounts": { - "target": "com.amazonaws.cloudformation#AccountList", - "traits": { - "smithy.api#documentation": "[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update\n parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts for which you want to update parameter values\n for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are\n currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future\n won't use the overridden values.
\nYou can specify Accounts or DeploymentTargets, but not both.
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.
", - "smithy.api#required": {} - } - }, - "ParameterOverrides": { - "target": "com.amazonaws.cloudformation#Parameters", - "traits": { - "smithy.api#documentation": "A list of input parameters whose values you want to update for the specified stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets\n parameter values during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
Preferences for how CloudFormation performs this stack set operation.
" - } - }, - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
", - "smithy.api#idempotencyToken": {} - } - }, - "CallAs": { - "target": "com.amazonaws.cloudformation#CallAs", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe unique identifier for this stack set operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#UpdateStackOutput": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "Unique identifier of the stack.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for an UpdateStack action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#UpdateStackSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#UpdateStackSetInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#UpdateStackSetOutput" - }, - "errors": [ - { - "target": "com.amazonaws.cloudformation#InvalidOperationException" - }, - { - "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" - }, - { - "target": "com.amazonaws.cloudformation#OperationInProgressException" - }, - { - "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StackSetNotFoundException" - }, - { - "target": "com.amazonaws.cloudformation#StaleRequestException" - } - ], - "traits": { - "smithy.api#documentation": "Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
\nEven if the stack set operation created by updating the stack set fails (completely or partially, below or above\n a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
" - } - }, - "com.amazonaws.cloudformation#UpdateStackSetInput": { - "type": "structure", - "members": { - "StackSetName": { - "target": "com.amazonaws.cloudformation#StackSetName", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack set that you want to update.
", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.cloudformation#Description", - "traits": { - "smithy.api#documentation": "A brief description of updates that you are making.
" - } - }, - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
A list of input parameters for the stack set template.
" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50\n tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
\nIf you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if\n you have the required IAM permission to tag resources. If you omit tags that are currently associated\n with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags\n from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary\n permission(s), the entire UpdateStackSet action fails with an access denied error, and the\n stack set is not updated.
Preferences for how CloudFormation performs this stack set operation.
" - } - }, - "AdministrationRoleARN": { - "target": "com.amazonaws.cloudformation#RoleARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" - } - }, - "ExecutionRoleName": { - "target": "com.amazonaws.cloudformation#ExecutionRoleName", - "traits": { - "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.
" - } - }, - "DeploymentTargets": { - "target": "com.amazonaws.cloudformation#DeploymentTargets", - "traits": { - "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.
\nTo update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.
If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances\n with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with\n their existing stack instance status.
Describes how the IAM roles required for stack set operations are created. You cannot modify\n PermissionModel if there are stack instances associated with your stack set.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
\nIf you specify AutoDeployment, don't specify DeploymentTargets or\n Regions.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#UpdateStackSetOutput": { - "type": "structure", - "members": { - "OperationId": { - "target": "com.amazonaws.cloudformation#ClientRequestToken", - "traits": { - "smithy.api#documentation": "The unique ID for this stack set operation.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#UpdateTerminationProtection": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput" - }, - "traits": { - "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" - } - }, - "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { - "type": "structure", - "members": { - "EnableTerminationProtection": { - "target": "com.amazonaws.cloudformation#EnableTerminationProtection", - "traits": { - "smithy.api#documentation": "Whether to enable termination protection on the specified stack.
", - "smithy.api#required": {} - } - }, - "StackName": { - "target": "com.amazonaws.cloudformation#StackNameOrId", - "traits": { - "smithy.api#documentation": "The name or unique ID of the stack for which you want to set termination protection.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.cloudformation#StackId", - "traits": { - "smithy.api#documentation": "The unique ID of the stack.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#Url": { - "type": "string" - }, - "com.amazonaws.cloudformation#UsePreviousTemplate": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#UsePreviousValue": { - "type": "boolean" - }, - "com.amazonaws.cloudformation#ValidateTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.cloudformation#ValidateTemplateInput" - }, - "output": { - "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" - }, - "traits": { - "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't,\n CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation\n returns a template validation error.
" - } - }, - "com.amazonaws.cloudformation#ValidateTemplateInput": { - "type": "structure", - "members": { - "TemplateBody": { - "target": "com.amazonaws.cloudformation#TemplateBody", - "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
The input for ValidateTemplate action.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.cloudformation#ValidateTemplateOutput": { - "type": "structure", - "members": { - "Parameters": { - "target": "com.amazonaws.cloudformation#TemplateParameters", - "traits": { - "smithy.api#documentation": "A list of TemplateParameter structures.
The description found within the template.
" - } - }, - "Capabilities": { - "target": "com.amazonaws.cloudformation#Capabilities", - "traits": { - "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return\n an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" - } - }, - "CapabilitiesReason": { - "target": "com.amazonaws.cloudformation#CapabilitiesReason", - "traits": { - "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response element.
A list of the transforms that are declared in the template.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The output for ValidateTemplate action.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.cloudformation#Value": { - "type": "string" - }, - "com.amazonaws.cloudformation#Version": { - "type": "string" - }, - "com.amazonaws.cloudformation#VersionBump": { - "type": "enum", - "members": { - "MAJOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAJOR" - } - }, - "MINOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINOR" - } - } - } - }, - "com.amazonaws.cloudformation#Visibility": { - "type": "enum", - "members": { - "PUBLIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUBLIC" - } - }, - "PRIVATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIVATE" - } - } - } - }, - "com.amazonaws.cloudformation#Warnings": { - "type": "structure", - "members": { - "UnrecognizedResourceTypes": { - "target": "com.amazonaws.cloudformation#ResourceTypes", - "traits": { - "smithy.api#documentation": "A list of all of the unrecognized resource types. This is only returned if the\n TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning\n configuration set to True.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably\n and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build\n highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member\n resources of the stack together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information\n about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", + "smithy.api#title": "AWS CloudFormation", + "smithy.api#xmlNamespace": { + "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" + }, + "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" + } + ] + } + ], + "type": "tree", + "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" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudformation-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://cloudformation.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudformation-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://cloudformation.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://cloudformation.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation-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://cloudformation-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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation-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://cloudformation-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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation.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://cloudformation-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://cloudformation.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://cloudformation.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://cloudformation.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-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://cloudformation-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://cloudformation.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://cloudformation-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.cloudformation#ConfigurationSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60000 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#ConnectionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$" + } + }, + "com.amazonaws.cloudformation#ContinueUpdateRollback": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ContinueUpdateRollbackInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ContinueUpdateRollbackOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all\n changes after a failed stack update. For example, you might have a stack that's rolling back to an old database\n instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was\n deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update\n rollback to fail.
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + } + }, + "ResourcesToSkip": { + "target": "com.amazonaws.cloudformation#ResourcesToSkip", + "traits": { + "smithy.api#documentation": "A list of the logical IDs of the resources that CloudFormation skips during the continue update rollback\n operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed.\n You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because\n an update was canceled. To check why a resource update failed, use the DescribeStackResources\n action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back.\n We recommend that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified\n resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the\n state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before\n performing another stack update, you must update the stack or resources to be consistent with each other. If you\n don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with\n the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
The input for the ContinueUpdateRollback action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ContinueUpdateRollbackOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The output for a ContinueUpdateRollback operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#CreateChangeSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#CreateChangeSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#CreateChangeSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#AlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" + }, + { + "target": "com.amazonaws.cloudformation#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you\n create a change set for an existing stack, CloudFormation compares the stack's information with the information\n that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update\n a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT\n for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,\n CloudFormation starts creating the change set. To check the status of the change set or to review it, use the\n DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change\n set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the\n change set by comparing this stack's information with the information that you submit, such as a modified template or\n different parameter input values.
", + "smithy.api#required": {} + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the\n stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the\n change set by comparing this template with the stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
Whether to reuse the template that's associated with the stack to create the change set.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the change set. For more\n information, see the Parameter data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom\n processing on templates.
\nThe template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Controlling access\n with Identity and Access Management in the CloudFormation User Guide.
" + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation\n assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure\n that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If\n no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" + } + }, + "RollbackConfiguration": { + "target": "com.amazonaws.cloudformation#RollbackConfiguration", + "traits": { + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + } + }, + "NotificationARNs": { + "target": "com.amazonaws.cloudformation#NotificationARNs", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation\n associates with the stack. To remove all associated notification topics, specify an empty list.
" + } + }, + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the\n stack. You can specify a maximum of 50 tags.
" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetName", + "traits": { + "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are associated with the specified\n stack.
\nA change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an\n alphabetical character and can't exceed 128 characters.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.cloudformation#ClientToken", + "traits": { + "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name.\n You might retry CreateChangeSet requests to ensure that CloudFormation successfully received\n them.
A description to help you identify this change set.
" + } + }, + "ChangeSetType": { + "target": "com.amazonaws.cloudformation#ChangeSetType", + "traits": { + "smithy.api#documentation": "The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no\n template or resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to\n create a change set for a new stack or the CREATE type to create a change set for an existing\n stack.
The resources to import into your stack.
" + } + }, + "IncludeNestedStacks": { + "target": "com.amazonaws.cloudformation#IncludeNestedStacks", + "traits": { + "smithy.api#documentation": "Creates a change set for the all nested stacks specified in the template. The default behavior of this action is\n set to False. To include nested sets in a change set, specify True.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
The input for the CreateChangeSet action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#CreateChangeSetOutput": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.cloudformation#ChangeSetId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the change set.
" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The unique ID of the stack.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for the CreateChangeSet action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#CreateStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#CreateStackInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#CreateStackOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#AlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" + }, + { + "target": "com.amazonaws.cloudformation#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.\n You can check the status of the stack through the DescribeStacks operation.
" + } + }, + "com.amazonaws.cloudformation#CreateStackInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name that's associated with the stack. The name must be unique in the Region in which you are creating the\n stack.
\nA stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an\n alphabetical character and can't be longer than 128 characters.
\nStructure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template anatomy in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" + } + }, + "TimeoutInMinutes": { + "target": "com.amazonaws.cloudformation#TimeoutMinutes", + "traits": { + "smithy.api#documentation": "The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback\n is not set or is set to false, the stack will be rolled back.
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros to perform custom\n processing on templates.
\nThe template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a specific custom resource), AWS::service_name::* (for all resources\n of a particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
" + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + } + }, + "OnFailure": { + "target": "com.amazonaws.cloudformation#OnFailure", + "traits": { + "smithy.api#documentation": "Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources\n created in the stack. A maximum number of 50 tags can be specified.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with\n termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide. Termination protection is deactivated on stacks\n by default.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + } + }, + "RetainExceptOnCreate": { + "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", + "traits": { + "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
The input for CreateStack action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#CreateStackInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#CreateStackInstancesInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#CreateStackInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#OperationInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StaleRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack\n instance refers to a stack in a specific account and Region. You must specify at least one value for either\n Accounts or DeploymentTargets, and you must specify at least one value for\n Regions.
The name or unique ID of the stack set that you want to create stack instances from.
", + "smithy.api#required": {} + } + }, + "Accounts": { + "target": "com.amazonaws.cloudformation#AccountList", + "traits": { + "smithy.api#documentation": "[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack\n instances in the specified Region(s) for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts for which to create stack instances in the\n specified Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not both.
The names of one or more Amazon Web Services Regions where you want to create stack instances using the specified\n Amazon Web Services accounts.
", + "smithy.api#required": {} + } + }, + "ParameterOverrides": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of stack set parameters whose values you want to override in the selected stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets\n parameter values during stack instance operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template.
" + } + }, + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "traits": { + "smithy.api#documentation": "Preferences for how CloudFormation performs this stack set operation.
" + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe unique identifier for this stack set operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#CreateStackOutput": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "Unique identifier of the stack.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for a CreateStack action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#CreateStackSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#CreateStackSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#CreateStackSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CreatedButModifiedException" + }, + { + "target": "com.amazonaws.cloudformation#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudformation#NameAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a stack set.
" + } + }, + "com.amazonaws.cloudformation#CreateStackSetInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name to associate with the stack set. The name must be unique in the Region where you create your stack\n set.
\nA stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an\n alphabetic character and can't be longer than 128 characters.
\nA description of the stack set. You can use the description to identify the stack set's purpose or other\n important information.
" + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + } + }, + "TemplateURL": { + "target": "com.amazonaws.cloudformation#TemplateURL", + "traits": { + "smithy.api#documentation": "The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see\n Template Anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The stack ID you are importing into a new stack set. Specify the Amazon Resource Name (ARN) of the stack.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "The input parameters for the stack set template.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in\n order for CloudFormation to create the stack set and related stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stack sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must create the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n create the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions don't currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be\n specified.
\nIf you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you\n have the required IAM permission to tag resources. If you don't, the entire\n CreateStackSet action fails with an access denied error, and the stack set is not\n created.
The Amazon Resource Name (ARN) of the IAM role to use to create this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
" + } + }, + "ExecutionRoleName": { + "target": "com.amazonaws.cloudformation#ExecutionRoleName", + "traits": { + "smithy.api#documentation": "The name of the IAM execution role to use to create the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
" + } + }, + "PermissionModel": { + "target": "com.amazonaws.cloudformation#PermissionModels", + "traits": { + "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created. By default,\n SELF-MANAGED is specified.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Describes whether StackSets automatically deploys to Organizations accounts that are added to the target\n organization or organizational unit (OU). Specify only if PermissionModel is\n SERVICE_MANAGED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
To create a stack set with service-managed permissions while signed in to the management account,\n specify SELF.
To create a stack set with service-managed permissions while signed in to a delegated administrator account,\n specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated admin in the management account.\n For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nStack sets with service-managed permissions are created in the management account, including stack\n sets that are created by delegated administrators.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A unique identifier for this CreateStackSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another stack set with the same\n name. You might retry CreateStackSet requests to ensure that CloudFormation successfully\n received them.
If you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#idempotencyToken": {} + } + }, + "ManagedExecution": { + "target": "com.amazonaws.cloudformation#ManagedExecution", + "traits": { + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#CreateStackSetOutput": { + "type": "structure", + "members": { + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "The ID of the stack set that you're creating.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#CreatedButModifiedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CreatedButModifiedException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "The specified resource exists, but has been changed.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudformation#CreationTime": { + "type": "timestamp" + }, + "com.amazonaws.cloudformation#DeactivateOrganizationsAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DeactivateOrganizationsAccessOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deactivates trusted access with Organizations. If trusted access is deactivated,\n the management account does not have permissions to create and manage\n service-managed StackSets for your organization.
" + } + }, + "com.amazonaws.cloudformation#DeactivateOrganizationsAccessInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DeactivateOrganizationsAccessOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DeactivateType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DeactivateTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DeactivateTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack\n update operations where the stack template includes the extension, even if no updates are being made to the\n extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is\n released.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#DeactivateTypeInput": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The type name of the extension, in this account and Region. If you specified a type name alias when enabling the\n extension, use the type name alias.
\nConditional: You must specify either Arn, or TypeName and Type.
The extension type.
\nConditional: You must specify either Arn, or TypeName and Type.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nConditional: You must specify either Arn, or TypeName and Type.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the change set.
\nIf IncludeNestedStacks specifies True during the creation of the nested change set,\n then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also\n delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
The name or Amazon Resource Name (ARN) of the change set that you want to delete.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's\n associated with it.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the DeleteChangeSet action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DeleteChangeSetOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The output for the DeleteChangeSet action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DeleteStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DeleteStackInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't\n show up in the DescribeStacks operation if the deletion has been completed successfully.
" + } + }, + "com.amazonaws.cloudformation#DeleteStackInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack.
", + "smithy.api#required": {} + } + }, + "RetainResources": { + "target": "com.amazonaws.cloudformation#RetainResources", + "traits": { + "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the\n retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your\n behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n DeleteStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The input for DeleteStack action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DeleteStackInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DeleteStackInstancesInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DeleteStackInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#OperationInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StaleRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.
" + } + }, + "com.amazonaws.cloudformation#DeleteStackInstancesInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that you want to delete stack instances for.
", + "smithy.api#required": {} + } + }, + "Accounts": { + "target": "com.amazonaws.cloudformation#AccountList", + "traits": { + "smithy.api#documentation": "[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances\n for.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts from which to delete stack instances.
\nYou can specify Accounts or DeploymentTargets, but not both.
The Amazon Web Services Regions where you want to delete stack set instances.
", + "smithy.api#required": {} + } + }, + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "traits": { + "smithy.api#documentation": "Preferences for how CloudFormation performs this stack set operation.
" + } + }, + "RetainStacks": { + "target": "com.amazonaws.cloudformation#RetainStacks", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a\n retained stack or add an existing, saved stack to a new stack set.
\nFor more information, see Stack set operation\n options.
", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique identifier for this stack set operation.
\nIf you don't specify an operation ID, the SDK generates one automatically.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You can retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe unique identifier for this stack set operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DeleteStackSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DeleteStackSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DeleteStackSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#OperationInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotEmptyException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a stack set. Before you can delete a stack set, all its member stack instances must be deleted. For more\n information about how to complete this, see DeleteStackInstances.
" + } + }, + "com.amazonaws.cloudformation#DeleteStackSetInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.
", + "smithy.api#required": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe names of one or more Amazon Web Services accounts for which you want to deploy stack set updates.
" + } + }, + "AccountsUrl": { + "target": "com.amazonaws.cloudformation#AccountsUrl", + "traits": { + "smithy.api#documentation": "Returns the value of the AccountsUrl property.
The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
" + } + }, + "AccountFilterType": { + "target": "com.amazonaws.cloudformation#AccountFilterType", + "traits": { + "smithy.api#documentation": "Limit deployment targets to individual accounts or include additional accounts with provided OUs.
\nThe following is a list of possible values for the AccountFilterType operation.
\n INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter.\n
\n DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This\n enables user to avoid certain accounts within an OU such as suspended accounts.
\n UNION: StackSets includes additional accounts deployment targets.
This is the default value if AccountFilterType is not provided. This enables user to update an\n entire OU and individual accounts from a different OU in one request, which used to be two separate\n requests.
\n NONE: Deploys to all the accounts in specified organizational units (OU).
[Service-managed permissions] The Organizations accounts to which StackSets deploys. StackSets doesn't\n deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.
\nFor update operations, you can specify either Accounts or OrganizationalUnitIds. For\n create and delete operations, specify OrganizationalUnitIds.
Marks an extension or extension version as DEPRECATED in the CloudFormation registry,\n removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation\n operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#DeregisterTypeInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#PrivateTypeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DeregisterTypeOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeAccountLimits": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeAccountLimitsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" + }, + "traits": { + "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in\n your account. For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AccountLimits" + } + } + }, + "com.amazonaws.cloudformation#DescribeAccountLimitsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string that identifies the next page of limits that you want to retrieve.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the DescribeAccountLimits action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeAccountLimitsOutput": { + "type": "structure", + "members": { + "AccountLimits": { + "target": "com.amazonaws.cloudformation#AccountLimitList", + "traits": { + "smithy.api#documentation": "An account limit structure that contain a list of CloudFormation account limits and their values.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page\n exists, this value is null.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for the DescribeAccountLimits action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeChangeSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeChangeSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeChangeSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the\n change set. For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", + "smithy.api#suppress": [ + "WaitableTraitInvalidErrorType" + ], + "smithy.waiters#waitable": { + "ChangeSetCreateComplete": { + "documentation": "Wait until change set status is CREATE_COMPLETE.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "Status", + "expected": "CREATE_COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "Status", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "errorType": "ValidationError" + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.cloudformation#DescribeChangeSetHooks": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeChangeSetHooksInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeChangeSetHooksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you\n run the change set.
" + } + }, + "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { + "type": "structure", + "members": { + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want to describe.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want\n to describe.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of\n information that you want to retrieve.
If specified, lists only the hooks related to the specified LogicalResourceId.
The change set identifier (stack ID).
" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetName", + "traits": { + "smithy.api#documentation": "The change set name.
" + } + }, + "Hooks": { + "target": "com.amazonaws.cloudformation#ChangeSetHooks", + "traits": { + "smithy.api#documentation": "List of hook objects.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#ChangeSetHooksStatus", + "traits": { + "smithy.api#documentation": "Provides the status of the change set hook.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "Pagination token, null or empty if no more results.
The stack identifier (stack ID).
" + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The stack name.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeChangeSetInput": { + "type": "structure", + "members": { + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want to describe.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to\n describe.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string (provided by the DescribeChangeSet response output) that identifies the next page of\n information that you want to retrieve.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the DescribeChangeSet action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeChangeSetOutput": { + "type": "structure", + "members": { + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetName", + "traits": { + "smithy.api#documentation": "The name of the change set.
" + } + }, + "ChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the change set.
" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stack that's associated with the change set.
" + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name of the stack that's associated with the change set.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "Information about the change set.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the Parameter data type.
The start time when the change set was created, in UTC.
" + } + }, + "ExecutionStatus": { + "target": "com.amazonaws.cloudformation#ExecutionStatus", + "traits": { + "smithy.api#documentation": "If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
" + } + }, + "NotificationARNs": { + "target": "com.amazonaws.cloudformation#NotificationARNs", + "traits": { + "smithy.api#documentation": "The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you\n execute the change set.
" + } + }, + "RollbackConfiguration": { + "target": "com.amazonaws.cloudformation#RollbackConfiguration", + "traits": { + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set\n was created.
" + } + }, + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", + "traits": { + "smithy.api#documentation": "If you execute the change set, the tags that will be associated with the stack.
" + } + }, + "Changes": { + "target": "com.amazonaws.cloudformation#Changes", + "traits": { + "smithy.api#documentation": "A list of Change structures that describes the resources CloudFormation changes if you execute\n the change set.
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page,\n this value is null.
" + } + }, + "IncludeNestedStacks": { + "target": "com.amazonaws.cloudformation#IncludeNestedStacks", + "traits": { + "smithy.api#documentation": "Verifies if IncludeNestedStacks is set to True.
Specifies the change set ID of the parent change set in the current nested change set hierarchy.
" + } + }, + "RootChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", + "traits": { + "smithy.api#documentation": "Specifies the change set ID of the root change set in the current nested change set hierarchy.
" + } + }, + "OnStackFailure": { + "target": "com.amazonaws.cloudformation#OnStackFailure", + "traits": { + "smithy.api#documentation": "Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
The output for the DescribeChangeSet action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeOrganizationsAccess": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccessInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeOrganizationsAccessOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\nPresents the status of the OrganizationAccess.
Returns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide\n
\nThe ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
The ID of the extension publisher.
" + } + }, + "PublisherStatus": { + "target": "com.amazonaws.cloudformation#PublisherStatus", + "traits": { + "smithy.api#documentation": "Whether the publisher is verified. Currently, all registered publishers are verified.
" + } + }, + "IdentityProvider": { + "target": "com.amazonaws.cloudformation#IdentityProvider", + "traits": { + "smithy.api#documentation": "The type of account used as the identity provider when registering this publisher with CloudFormation.
" + } + }, + "PublisherProfile": { + "target": "com.amazonaws.cloudformation#PublisherProfile", + "traits": { + "smithy.api#documentation": "The URL to the publisher's profile with the identity provider.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" + }, + "traits": { + "smithy.api#documentation": "Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The ID of the stack.
", + "smithy.api#required": {} + } + }, + "StackDriftDetectionId": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "traits": { + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.
", + "smithy.api#required": {} + } + }, + "StackDriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all\n resources in the stack that support drift detection. (Resources that don't currently support stack detection remain\n unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,\n only the resources with those logical IDs are checked for drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the\n stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
The reason the stack drift detection operation has its current status.
" + } + }, + "DriftedStackResourceCount": { + "target": "com.amazonaws.cloudformation#BoxedInteger", + "traits": { + "smithy.api#documentation": "Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is\n IN_SYNC.
Time at which the stack drift detection operation was initiated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackEventsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackEventsOutput" + }, + "traits": { + "smithy.api#documentation": "Returns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, go to Stacks in the CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string that identifies the next page of events that you want to retrieve.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for DescribeStackEvents action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackEventsOutput": { + "type": "structure", + "members": { + "StackEvents": { + "target": "com.amazonaws.cloudformation#StackEvents", + "traits": { + "smithy.api#documentation": "A list of StackEvents structures.
If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page\n exists, this value is null.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for a DescribeStackEvents action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackInstanceInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackInstanceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the stack instance that's associated with the specified StackSet, Amazon Web Services account, and\n Amazon Web Services Region.
\nFor a list of stack instances that are associated with a specific StackSet, use ListStackInstances.
" + } + }, + "com.amazonaws.cloudformation#DescribeStackInstanceInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or the unique stack ID of the stack set that you want to get stack instance information for.
", + "smithy.api#required": {} + } + }, + "StackInstanceAccount": { + "target": "com.amazonaws.cloudformation#Account", + "traits": { + "smithy.api#documentation": "The ID of an Amazon Web Services account that's associated with this stack instance.
", + "smithy.api#required": {} + } + }, + "StackInstanceRegion": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "The name of a Region that's associated with this stack instance.
", + "smithy.api#required": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe stack instance that matches the specified request parameters.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackResourceInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackResourceOutput" + }, + "traits": { + "smithy.api#documentation": "Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.
" + } + }, + "com.amazonaws.cloudformation#DescribeStackResourceDrifts": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput" + }, + "traits": { + "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the specified stack. This\n includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#DescribeStackResourceDriftsInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "The name of the stack for which you want drift information.
", + "smithy.api#required": {} + } + }, + "StackResourceDriftStatusFilters": { + "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", + "traits": { + "smithy.api#documentation": "The resource drift status values to use as filters for the resource drift results returned.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
A string that identifies the next page of stack resource drift results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudformation#BoxedMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
Drift information for the resources that have been checked for drift in the specified stack. This includes\n actual and expected configuration values for resources where CloudFormation detects drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#required": {} + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource as specified in the template.
\nDefault: There is no default value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for DescribeStackResource action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackResourceOutput": { + "type": "structure", + "members": { + "StackResourceDetail": { + "target": "com.amazonaws.cloudformation#StackResourceDetail", + "traits": { + "smithy.api#documentation": "A StackResourceDetail structure containing the description of the specified resource in the\n specified stack.
The output for a DescribeStackResource action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackResources": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackResourcesInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackResourcesOutput" + }, + "traits": { + "smithy.api#documentation": "Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The logical name of the resource as specified in the template.
\nDefault: There is no default value.
" + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must specify\n StackName.
Default: There is no default value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for DescribeStackResources action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackResourcesOutput": { + "type": "structure", + "members": { + "StackResources": { + "target": "com.amazonaws.cloudformation#StackResources", + "traits": { + "smithy.api#documentation": "A list of StackResource structures.
The output for a DescribeStackResources action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStackSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStackSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the description of the specified StackSet.
" + } + }, + "com.amazonaws.cloudformation#DescribeStackSetInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set whose description you want.
", + "smithy.api#required": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nReturns the description of the specified StackSet operation.
" + } + }, + "com.amazonaws.cloudformation#DescribeStackSetOperationInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or the unique stack ID of the stack set for the stack operation.
", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique ID of the stack set operation.
", + "smithy.api#required": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe specified stack set operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStackSetOutput": { + "type": "structure", + "members": { + "StackSet": { + "target": "com.amazonaws.cloudformation#StackSet", + "traits": { + "smithy.api#documentation": "The specified stack set.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeStacks": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeStacksInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeStacksOutput" + }, + "traits": { + "smithy.api#documentation": "Returns the description for the specified stack; if no stack name was specified, then it returns the description\n for all the stacks created.
\nIf the stack doesn't exist, an ValidationError is returned.
If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.
Consider using the ListStacks API if you're not passing a parameter to StackName.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string that identifies the next page of stacks that you want to retrieve.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for DescribeStacks action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeStacksOutput": { + "type": "structure", + "members": { + "Stacks": { + "target": "com.amazonaws.cloudformation#Stacks", + "traits": { + "smithy.api#documentation": "A list of stack structures.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for a DescribeStacks action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns detailed information about an extension that has been registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
The publisher ID of the extension publisher.
\nExtensions provided by Amazon Web Services are not assigned a publisher ID.
" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of a public third-party extension.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeTypeOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" + } + }, + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", + "traits": { + "smithy.api#documentation": "The kind of extension.
" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation\n returns the type name alias. For more information, see ActivateType.
" + } + }, + "DefaultVersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", + "traits": { + "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For\n more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + } + }, + "IsDefaultVersion": { + "target": "com.amazonaws.cloudformation#IsDefaultVersion", + "traits": { + "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation\n returns null.
The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line\n Interface User Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "The description of the extension.
" + } + }, + "Schema": { + "target": "com.amazonaws.cloudformation#TypeSchema", + "traits": { + "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" + } + }, + "ProvisioningType": { + "target": "com.amazonaws.cloudformation#ProvisioningType", + "traits": { + "smithy.api#documentation": "For resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning\n type during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore\n can't actually be provisioned.
create
\nread
\ndelete
\nThe deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see RegisterType.
For extensions that are modules, the public third-party extensions that must be activated in your account in\n order for the module itself to be activated.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.cloudformation#RoleARN2", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This\n applies only to private extensions you have registered in your account. For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your extension with the appropriate\n credentials.
" + } + }, + "Visibility": { + "target": "com.amazonaws.cloudformation#Visibility", + "traits": { + "smithy.api#documentation": "The scope at which the extension is visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account in which it is registered.\n CloudFormation marks any extensions you register as PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.
The URL of the source code for the extension.
" + } + }, + "DocumentationUrl": { + "target": "com.amazonaws.cloudformation#OptionalSecureUrl", + "traits": { + "smithy.api#documentation": "The URL of a page providing detailed documentation for this extension.
" + } + }, + "LastUpdated": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nWhen the specified private extension version was registered or activated in your account.
" + } + }, + "ConfigurationSchema": { + "target": "com.amazonaws.cloudformation#ConfigurationSchema", + "traits": { + "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "The publisher ID of the extension publisher.
\nThis applies only to public third-party extensions. For private registered extensions, and extensions provided\n by Amazon Web Services, CloudFormation returns null.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of\n the public extension.
" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns\n null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.
Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions\n for use in your account in the CloudFormation User Guide.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DescribeTypeRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DescribeTypeRegistrationInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DescribeTypeRegistrationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an extension's registration, including its current status and type and version\n identifiers.
\nWhen you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
\nOnce the registration request has completed, use DescribeType to return detailed information\n about an extension.
", + "smithy.api#idempotent": {}, + "smithy.waiters#waitable": { + "TypeRegistrationComplete": { + "documentation": "Wait until type registration is COMPLETE.", + "acceptors": [ + { + "state": "success", + "matcher": { + "output": { + "path": "ProgressStatus", + "expected": "COMPLETE", + "comparator": "stringEquals" + } + } + }, + { + "state": "failure", + "matcher": { + "output": { + "path": "ProgressStatus", + "expected": "FAILED", + "comparator": "stringEquals" + } + } + } + ], + "minDelay": 30 + } + } + } + }, + "com.amazonaws.cloudformation#DescribeTypeRegistrationInput": { + "type": "structure", + "members": { + "RegistrationToken": { + "target": "com.amazonaws.cloudformation#RegistrationToken", + "traits": { + "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using\n RegisterType.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DescribeTypeRegistrationOutput": { + "type": "structure", + "members": { + "ProgressStatus": { + "target": "com.amazonaws.cloudformation#RegistrationStatus", + "traits": { + "smithy.api#documentation": "The current status of the extension registration request.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "The description of the extension registration request.
" + } + }, + "TypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
The name of the stack for which you want to detect drift.
", + "smithy.api#required": {} + } + }, + "LogicalResourceIds": { + "target": "com.amazonaws.cloudformation#LogicalResourceIds", + "traits": { + "smithy.api#documentation": "The logical names of any resources you want to use as filters.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DetectStackDriftOutput": { + "type": "structure", + "members": { + "StackDriftDetectionId": { + "target": "com.amazonaws.cloudformation#StackDriftDetectionId", + "traits": { + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DetectStackResourceDrift": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DetectStackResourceDriftInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DetectStackResourceDriftOutput" + }, + "traits": { + "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" + } + }, + "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "The name of the stack to which the resource belongs.
", + "smithy.api#required": {} + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource for which to return drift information.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#DetectStackResourceDriftOutput": { + "type": "structure", + "members": { + "StackResourceDrift": { + "target": "com.amazonaws.cloudformation#StackResourceDrift", + "traits": { + "smithy.api#documentation": "Information about whether the resource's actual configuration has drifted from its expected template\n configuration, including actual and expected property values and any differences detected.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DetectStackSetDrift": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#DetectStackSetDriftInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#DetectStackSetDriftOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs\n drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation\n performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" + } + }, + "com.amazonaws.cloudformation#DetectStackSetDriftInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetNameOrId", + "traits": { + "smithy.api#documentation": "The name of the stack set on which to perform the drift detection operation.
", + "smithy.api#required": {} + } + }, + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "traits": { + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "\n The ID of the stack set operation.\n
", + "smithy.api#idempotencyToken": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe ID of the drift detection stack set operation.
\nYou can use this operation ID with DescribeStackSetOperation to monitor the progress of the\n drift detection operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#DifferenceType": { + "type": "enum", + "members": { + "ADD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD" + } + }, + "REMOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REMOVE" + } + }, + "NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_EQUAL" + } + } + } + }, + "com.amazonaws.cloudformation#DisableRollback": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#DriftedStackInstancesCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudformation#EnableTerminationProtection": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + } + } + }, + "com.amazonaws.cloudformation#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudformation#EstimateTemplateCost": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#EstimateTemplateCostInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#EstimateTemplateCostOutput" + }, + "traits": { + "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly\n Calculator URL with a query string that describes the resources required to run the template.
" + } + }, + "com.amazonaws.cloudformation#EstimateTemplateCostInput": { + "type": "structure", + "members": { + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
A list of Parameter structures that specify input parameters.
The input for an EstimateTemplateCost action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#EstimateTemplateCostOutput": { + "type": "structure", + "members": { + "Url": { + "target": "com.amazonaws.cloudformation#Url", + "traits": { + "smithy.api#documentation": "An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to\n run the template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for a EstimateTemplateCost action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#EvaluationType": { + "type": "enum", + "members": { + "Static": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Static" + } + }, + "Dynamic": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Dynamic" + } + } + } + }, + "com.amazonaws.cloudformation#EventId": { + "type": "string" + }, + "com.amazonaws.cloudformation#ExecuteChangeSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ExecuteChangeSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ExecuteChangeSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" + }, + { + "target": "com.amazonaws.cloudformation#InvalidChangeSetStatusException" + }, + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack\n because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You\n can't specify a temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's\n associated with the change set you want to execute.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with\n the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.
Preserves the state of previously provisioned resources when an operation\n fails. This parameter can't be specified when\n the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True\n
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
The input for the ExecuteChangeSet action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ExecuteChangeSetOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The output for the ExecuteChangeSet action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ExecutionRoleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9+=,.@-]+$" + } + }, + "com.amazonaws.cloudformation#ExecutionStatus": { + "type": "enum", + "members": { + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "EXECUTE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTE_IN_PROGRESS" + } + }, + "EXECUTE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTE_COMPLETE" + } + }, + "EXECUTE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXECUTE_FAILED" + } + }, + "OBSOLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OBSOLETE" + } + } + } + }, + "com.amazonaws.cloudformation#Export": { + "type": "structure", + "members": { + "ExportingStackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The stack that contains the exported output name and value.
" + } + }, + "Name": { + "target": "com.amazonaws.cloudformation#ExportName", + "traits": { + "smithy.api#documentation": "The name of exported output value. Use this name and the Fn::ImportValue function to import the\n associated value into other stacks. The name is defined in the Export field in the associated stack's\n Outputs section.
The value of the exported output, such as a resource physical ID. This value is defined in the\n Export field in the associated stack's Outputs section.
The Export structure describes the exported output values for a stack.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.
" + } + }, + "com.amazonaws.cloudformation#GetStackPolicyInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to get.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the GetStackPolicy action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#GetStackPolicyOutput": { + "type": "structure", + "members": { + "StackPolicyBody": { + "target": "com.amazonaws.cloudformation#StackPolicyBody", + "traits": { + "smithy.api#documentation": "Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for the GetStackPolicy action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#GetTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#GetTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#GetTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#ChangeSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the template body for a specified stack. You can get the template for running or deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been\n deleted.
If the template doesn't exist, a ValidationError is returned.
The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + } + }, + "ChangeSetName": { + "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", + "traits": { + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has\n processed all transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
The input for a GetTemplate action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#GetTemplateOutput": { + "type": "structure", + "members": { + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nCloudFormation returns the same template that was used when the stack was created.
" + } + }, + "StagesAvailable": { + "target": "com.amazonaws.cloudformation#StageList", + "traits": { + "smithy.api#documentation": "The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
The output for GetTemplate action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#GetTemplateSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#GetTemplateSummaryInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#GetTemplateSummaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a new or existing template. The GetTemplateSummary action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError is returned.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nSpecifies options for the GetTemplateSummary API action.
The input for the GetTemplateSummary action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#GetTemplateSummaryOutput": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.cloudformation#ParameterDeclarations", + "traits": { + "smithy.api#documentation": "A list of parameter declarations that describe various properties for each parameter.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "The value that's defined in the Description property of the template.
The capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those\n actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" + } + }, + "CapabilitiesReason": { + "target": "com.amazonaws.cloudformation#CapabilitiesReason", + "traits": { + "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response element.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
The Amazon Web Services template format version, which identifies the capabilities of the template.
" + } + }, + "Metadata": { + "target": "com.amazonaws.cloudformation#Metadata", + "traits": { + "smithy.api#documentation": "The value that's defined for the Metadata property of the template.
A list of the transforms that are declared in the template.
" + } + }, + "ResourceIdentifierSummaries": { + "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", + "traits": { + "smithy.api#documentation": "A list of resource identifier summaries that describe the target resources of an import operation and the\n properties you can provide during the import to identify the target resources. For example, BucketName\n is a possible identifier property for an AWS::S3::Bucket resource.
An object containing any warnings returned.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for the GetTemplateSummary action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#HandlerErrorCode": { + "type": "enum", + "members": { + "NotUpdatable": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotUpdatable" + } + }, + "InvalidRequest": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidRequest" + } + }, + "AccessDenied": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccessDenied" + } + }, + "InvalidCredentials": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidCredentials" + } + }, + "AlreadyExists": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AlreadyExists" + } + }, + "NotFound": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotFound" + } + }, + "ResourceConflict": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceConflict" + } + }, + "Throttling": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Throttling" + } + }, + "ServiceLimitExceeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceLimitExceeded" + } + }, + "ServiceTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotStabilized" + } + }, + "GeneralServiceException": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GeneralServiceException" + } + }, + "ServiceInternalError": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ServiceInternalError" + } + }, + "NetworkFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NetworkFailure" + } + }, + "InternalFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InternalFailure" + } + }, + "InvalidTypeConfiguration": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidTypeConfiguration" + } + }, + "HandlerInternalFailure": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HandlerInternalFailure" + } + }, + "NonCompliant": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NonCompliant" + } + }, + "Unknown": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Unknown" + } + }, + "UnsupportedTarget": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UnsupportedTarget" + } + } + } + }, + "com.amazonaws.cloudformation#HookFailureMode": { + "type": "enum", + "members": { + "FAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAIL" + } + }, + "WARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WARN" + } + } + } + }, + "com.amazonaws.cloudformation#HookInvocationCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudformation#HookInvocationPoint": { + "type": "enum", + "members": { + "PRE_PROVISION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRE_PROVISION" + } + } + } + }, + "com.amazonaws.cloudformation#HookStatus": { + "type": "enum", + "members": { + "HOOK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOOK_IN_PROGRESS" + } + }, + "HOOK_COMPLETE_SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOOK_COMPLETE_SUCCEEDED" + } + }, + "HOOK_COMPLETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOOK_COMPLETE_FAILED" + } + }, + "HOOK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOOK_FAILED" + } + } + } + }, + "com.amazonaws.cloudformation#HookStatusReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.cloudformation#HookTargetType": { + "type": "enum", + "members": { + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + } + } + }, + "com.amazonaws.cloudformation#HookTargetTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}::[a-zA-Z0-9]{2,64}$" + } + }, + "com.amazonaws.cloudformation#HookType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.cloudformation#HookTypeConfigurationVersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]+$" + } + }, + "com.amazonaws.cloudformation#HookTypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 196 + } + } + }, + "com.amazonaws.cloudformation#HookTypeVersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]+$" + } + }, + "com.amazonaws.cloudformation#IdentityProvider": { + "type": "enum", + "members": { + "AWS_Marketplace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_Marketplace" + } + }, + "GitHub": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GitHub" + } + }, + "Bitbucket": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Bitbucket" + } + } + } + }, + "com.amazonaws.cloudformation#ImportStacksToStackSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ImportStacksToStackSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ImportStacksToStackSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#OperationInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#StackNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StaleRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Import existing stacks into a new stack sets. Use the stack import operation to import up to 10 stacks into a\n new stack set in the same account as the source stack or in a different administrator account and Region, by\n specifying the stack ID of the stack you intend to import.
" + } + }, + "com.amazonaws.cloudformation#ImportStacksToStackSetInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetNameOrId", + "traits": { + "smithy.api#documentation": "The name of the stack set. The name must be unique in the Region where you create your stack set.
", + "smithy.api#required": {} + } + }, + "StackIds": { + "target": "com.amazonaws.cloudformation#StackIdList", + "traits": { + "smithy.api#documentation": "The IDs of the stacks you are importing into a stack set. You import up to 10 stacks per stack set at a\n time.
\nSpecify either StackIds or StackIdsUrl.
The Amazon S3 URL which contains list of stack ids to be inputted.
\nSpecify either StackIds or StackIdsUrl.
The list of OU ID's to which the stacks being imported has to be mapped as deployment target.
" + } + }, + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "traits": { + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A unique, user defined, identifier for the stack set operation.
", + "smithy.api#idempotencyToken": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "By default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
For service managed stack sets, specify DELEGATED_ADMIN.
The unique identifier for the stack set operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#Imports": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackName" + } + }, + "com.amazonaws.cloudformation#InProgressStackInstancesCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudformation#InSyncStackInstancesCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudformation#IncludeNestedStacks": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#InsufficientCapabilitiesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientCapabilitiesException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The template contains resources with capabilities that weren't specified in the Capabilities parameter.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#InvalidChangeSetStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidChangeSetStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified change set can't be used to update the stack. For example, the change set status might be\n CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.
The specified operation isn't valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#InvalidStateTransitionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidStateTransition", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#IsActivated": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#IsDefaultConfiguration": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#IsDefaultVersion": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#Key": { + "type": "string" + }, + "com.amazonaws.cloudformation#LastUpdatedTime": { + "type": "timestamp" + }, + "com.amazonaws.cloudformation#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The quota for the resource has already been reached.
\nFor information about resource and stack limitations, see CloudFormation quotas in the\n CloudFormation User Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#LimitName": { + "type": "string" + }, + "com.amazonaws.cloudformation#LimitValue": { + "type": "integer" + }, + "com.amazonaws.cloudformation#ListChangeSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListChangeSetsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" + }, + "traits": { + "smithy.api#documentation": "Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the ListChangeSets action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListChangeSetsOutput": { + "type": "structure", + "members": { + "Summaries": { + "target": "com.amazonaws.cloudformation#ChangeSetSummaries", + "traits": { + "smithy.api#documentation": "A list of ChangeSetSummary structures that provides the ID and status of each change set for the\n specified stack.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null.
The output for the ListChangeSets action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListExportsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListExportsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see \n CloudFormation export stack output values.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Exports" + } + } + }, + "com.amazonaws.cloudformation#ListExportsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListExportsOutput": { + "type": "structure", + "members": { + "Exports": { + "target": "com.amazonaws.cloudformation#Exports", + "traits": { + "smithy.api#documentation": "The output for the ListExports action.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListImportsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListImportsOutput" + }, + "traits": { + "smithy.api#documentation": "Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue\n function.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Imports" + } + } + }, + "com.amazonaws.cloudformation#ListImportsInput": { + "type": "structure", + "members": { + "ExportName": { + "target": "com.amazonaws.cloudformation#ExportName", + "traits": { + "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListImportsOutput": { + "type": "structure", + "members": { + "Imports": { + "target": "com.amazonaws.cloudformation#Imports", + "traits": { + "smithy.api#documentation": "A list of stack names that are importing the specified exported output value.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this value is null.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListStackInstanceResourceDrifts": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListStackInstanceResourceDriftsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListStackInstanceResourceDriftsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#OperationNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns drift information for resources in a stack instance.
\n\n ListStackInstanceResourceDrifts returns drift information for the most\n recent drift detection operation. If an operation is in progress, it may only return\n partial results.
The name or unique ID of the stack set that you want to list drifted resources\n for.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken\n value that you can assign to the NextToken request parameter to get the next\n set of results.
The resource drift status of the stack instance.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The name of the Amazon Web Services account that you want to list resource drifts for.
", + "smithy.api#required": {} + } + }, + "StackInstanceRegion": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "The name of the Region where you want to list resource drifts.
", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique ID of the drift operation.
", + "smithy.api#required": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated\n administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in\n the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
\nA list of StackInstanceResourceDriftSummary structures that contain\n information about the specified stack instances.
If the previous paginated request didn't return all of the remaining results, the\n response object's NextToken parameter value is set to a token. To retrieve the\n next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
Returns summary information about stack instances that are associated with the specified stack set. You can\n filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that\n have a specific status.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#ListStackInstancesInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that you want to list stack instances for.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the previous request didn't return all the remaining results, the response's NextToken parameter\n value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign\n that token to the request object's NextToken parameter. If there are no remaining results, the previous\n response object's NextToken parameter is set to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The filter to apply to stack instances
" + } + }, + "StackInstanceAccount": { + "target": "com.amazonaws.cloudformation#Account", + "traits": { + "smithy.api#documentation": "The name of the Amazon Web Services account that you want to list stack instances for.
" + } + }, + "StackInstanceRegion": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "The name of the Region where you want to list stack instances.
" + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nA list of StackInstanceSummary structures that contain information about the specified stack\n instances.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call ListStackInstances again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StackResourceSummaries" + } + } + }, + "com.amazonaws.cloudformation#ListStackResourcesInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string that identifies the next page of stack resources that you want to retrieve.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the ListStackResource action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListStackResourcesOutput": { + "type": "structure", + "members": { + "StackResourceSummaries": { + "target": "com.amazonaws.cloudformation#StackResourceSummaries", + "traits": { + "smithy.api#documentation": "A list of StackResourceSummary structures.
If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page\n exists, this value is null.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for a ListStackResources action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListStackSetOperationResults": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListStackSetOperationResultsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListStackSetOperationResultsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#OperationNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns summary information about the results of a stack set operation.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#ListStackSetOperationResultsInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that you want to get operation results for.
", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The ID of the stack set operation.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the previous request didn't return all the remaining results, the response object's NextToken\n parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperationResults again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe filter to apply to operation results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListStackSetOperationResultsOutput": { + "type": "structure", + "members": { + "Summaries": { + "target": "com.amazonaws.cloudformation#StackSetOperationResultSummaries", + "traits": { + "smithy.api#documentation": "A list of StackSetOperationResultSummary structures that contain information about the specified\n operation results, for accounts and Amazon Web Services Regions that are included in the operation.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
Returns summary information about operations performed on a stack set.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Summaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#ListStackSetOperationsInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that you want to get operation summaries for.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSetOperations again and assign that token to the request object's NextToken\n parameter. If there are no remaining results, the previous response object's NextToken parameter is set\n to null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nA list of StackSetOperationSummary structures that contain summary information about operations for\n the specified stack set.
If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of\n results, call ListOperationResults again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, NextToken is set to\n null.
Returns summary information about stack sets that are associated with the user.
\n[Self-managed permissions] If you set the CallAs parameter to SELF while signed in\n to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
[Service-managed permissions] If you set the CallAs parameter to SELF while signed\n in to the organization's management account, ListStackSets returns all stack sets in the\n management account.
[Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN\n while signed in to your member account, ListStackSets returns all stack sets with service-managed\n permissions in the management account.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call\n ListStackSets again and assign that token to the request object's NextToken parameter. If\n there are no remaining results, the previous response object's NextToken parameter is set to\n null.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
The status of the stack sets that you want to get summary information about.
" + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nA list of StackSetSummary structures that contain information about the user's stack sets.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call ListStackInstances again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter\n is specified, summary information for all stacks is returned (including existing stacks and stacks that have been\n deleted).
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "StackSummaries" + } + } + }, + "com.amazonaws.cloudformation#ListStacksInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "A string that identifies the next page of stacks that you want to retrieve.
" + } + }, + "StackStatusFilter": { + "target": "com.amazonaws.cloudformation#StackStatusFilter", + "traits": { + "smithy.api#documentation": "Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
The input for ListStacks action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListStacksOutput": { + "type": "structure", + "members": { + "StackSummaries": { + "target": "com.amazonaws.cloudformation#StackSummaries", + "traits": { + "smithy.api#documentation": "A list of StackSummary structures containing information about the specified stacks.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for ListStacks action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ListTypeRegistrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ListTypeRegistrationsInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ListTypeRegistrationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of registration tokens for the specified extension(s).
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#ListTypeRegistrationsInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", + "traits": { + "smithy.api#documentation": "The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The current status of the extension registration request.
\nThe default is IN_PROGRESS.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
A list of extension registration tokens.
\nUse DescribeTypeRegistration to return detailed information about a type registration\n request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudformation#NextToken", + "traits": { + "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
Returns summary information about the versions of an extension.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#ListTypeVersionsInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", + "traits": { + "smithy.api#documentation": "The kind of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
The publisher ID of the extension publisher.
\nExtensions published by Amazon aren't assigned a publisher ID.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ListTypeVersionsOutput": { + "type": "structure", + "members": { + "TypeVersionSummaries": { + "target": "com.amazonaws.cloudformation#TypeVersionSummaries", + "traits": { + "smithy.api#documentation": "A list of TypeVersionSummary structures that contain information about the specified extension's\n versions.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
Returns summary information about extension that have been registered with CloudFormation.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TypeSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudformation#ListTypesInput": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.cloudformation#Visibility", + "traits": { + "smithy.api#documentation": "The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party\n publishers.
The default is PRIVATE.
For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type\n during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and\n therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
The deprecation status of the extension that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension is registered for use in CloudFormation operations.
\n DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
The type of extension.
" + } + }, + "Filters": { + "target": "com.amazonaws.cloudformation#TypeFilters", + "traits": { + "smithy.api#documentation": "Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
A list of TypeSummary structures that contain information about the specified extensions.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
The Amazon Resource Name (ARN) of the role that CloudFormation should assume when sending log entries\n to CloudWatch Logs.
", + "smithy.api#required": {} + } + }, + "LogGroupName": { + "target": "com.amazonaws.cloudformation#LogGroupName", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch Logs group to which CloudFormation sends error logging information when invoking\n the extension's handlers.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains logging configuration information for an extension.
" + } + }, + "com.amazonaws.cloudformation#LogicalIdHierarchy": { + "type": "string" + }, + "com.amazonaws.cloudformation#LogicalResourceId": { + "type": "string" + }, + "com.amazonaws.cloudformation#LogicalResourceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#LogicalResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.cloudformation#MajorVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100000 + } + } + }, + "com.amazonaws.cloudformation#ManagedExecution": { + "type": "structure", + "members": { + "Active": { + "target": "com.amazonaws.cloudformation#ManagedExecutionNullable", + "traits": { + "smithy.api#documentation": "When true, StackSets performs non-conflicting operations concurrently and queues conflicting\n operations. After conflicting operations finish, StackSets starts queued operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations even if they are\n non-conflicting.
\nYou can't modify your stack set's execution configuration while there are running or queued operations for that\n stack set.
\nWhen false (default), StackSets performs one operation at a time in request order.
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" + } + }, + "com.amazonaws.cloudformation#ManagedExecutionNullable": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#MaxConcurrentCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.cloudformation#MaxConcurrentPercentage": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudformation#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.cloudformation#Metadata": { + "type": "string" + }, + "com.amazonaws.cloudformation#ModuleInfo": { + "type": "structure", + "members": { + "TypeHierarchy": { + "target": "com.amazonaws.cloudformation#TypeHierarchy", + "traits": { + "smithy.api#documentation": "A concatenated list of the module type or types containing the resource. Module types are listed starting with\n the inner-most nested module, and separated by /.
In the following example, the resource was created from a module of type\n AWS::First::Example::MODULE, that's nested inside a parent module of type\n AWS::Second::Example::MODULE.
\n AWS::First::Example::MODULE/AWS::Second::Example::MODULE\n
A concatenated list of the logical IDs of the module or modules containing the resource. Modules are listed\n starting with the inner-most nested module, and separated by /.
In the following example, the resource was created from a module, moduleA, that's nested inside a\n parent module, moduleB.
\n moduleA/moduleB\n
For more information, see Referencing resources in a module\n in the CloudFormation User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
\nFor more information about modules, see Using modules to encapsulate and reuse resource\n configurations in the CloudFormation User Guide.
" + } + }, + "com.amazonaws.cloudformation#MonitoringTimeInMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 180 + } + } + }, + "com.amazonaws.cloudformation#NameAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NameAlreadyExistsException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "The specified name is already in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudformation#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.cloudformation#NoEcho": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#NotificationARN": { + "type": "string" + }, + "com.amazonaws.cloudformation#NotificationARNs": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#NotificationARN" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudformation#OnFailure": { + "type": "enum", + "members": { + "DO_NOTHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOTHING" + } + }, + "ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.cloudformation#OnStackFailure": { + "type": "enum", + "members": { + "DO_NOTHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOTHING" + } + }, + "ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + } + } + }, + "com.amazonaws.cloudformation#OperationIdAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationIdAlreadyExistsException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "The specified operation ID already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudformation#OperationInProgressException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationInProgressException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "Another operation is currently in progress for this stack set. Only one operation can be performed for a stack\n set at a given time.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudformation#OperationNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified ID refers to an operation that doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudformation#OperationResultFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudformation#OperationResultFilterName", + "traits": { + "smithy.api#documentation": "The type of filter to apply.
" + } + }, + "Values": { + "target": "com.amazonaws.cloudformation#OperationResultFilterValues", + "traits": { + "smithy.api#documentation": "The value to filter by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The status that operation results are filtered by.
" + } + }, + "com.amazonaws.cloudformation#OperationResultFilterName": { + "type": "enum", + "members": { + "OPERATION_RESULT_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPERATION_RESULT_STATUS" + } + } + } + }, + "com.amazonaws.cloudformation#OperationResultFilterValues": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 6, + "max": 9 + }, + "smithy.api#pattern": "^\\S{6,9}$" + } + }, + "com.amazonaws.cloudformation#OperationResultFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#OperationResultFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.cloudformation#OperationStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.cloudformation#OperationStatusCheckFailedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConditionalCheckFailed", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Error reserved for use by the CloudFormation CLI.\n CloudFormation doesn't return this error to users.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#OptionalSecureUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.cloudformation#OrganizationStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "DISABLED_PERMANENTLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED_PERMANENTLY" + } + } + } + }, + "com.amazonaws.cloudformation#OrganizationalUnitId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$" + } + }, + "com.amazonaws.cloudformation#OrganizationalUnitIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#OrganizationalUnitId" + } + }, + "com.amazonaws.cloudformation#Output": { + "type": "structure", + "members": { + "OutputKey": { + "target": "com.amazonaws.cloudformation#OutputKey", + "traits": { + "smithy.api#documentation": "The key associated with the output.
" + } + }, + "OutputValue": { + "target": "com.amazonaws.cloudformation#OutputValue", + "traits": { + "smithy.api#documentation": "The value associated with the output.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "User defined description associated with the output.
" + } + }, + "ExportName": { + "target": "com.amazonaws.cloudformation#ExportName", + "traits": { + "smithy.api#documentation": "The name of the export associated with the output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Output data type.
" + } + }, + "com.amazonaws.cloudformation#OutputKey": { + "type": "string" + }, + "com.amazonaws.cloudformation#OutputValue": { + "type": "string" + }, + "com.amazonaws.cloudformation#Outputs": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Output" + } + }, + "com.amazonaws.cloudformation#Parameter": { + "type": "structure", + "members": { + "ParameterKey": { + "target": "com.amazonaws.cloudformation#ParameterKey", + "traits": { + "smithy.api#documentation": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.
" + } + }, + "ParameterValue": { + "target": "com.amazonaws.cloudformation#ParameterValue", + "traits": { + "smithy.api#documentation": "The input value associated with the parameter.
" + } + }, + "UsePreviousValue": { + "target": "com.amazonaws.cloudformation#UsePreviousValue", + "traits": { + "smithy.api#documentation": "During a stack update, use the existing parameter value that the stack is using for a given parameter key. If\n you specify true, do not specify a parameter value.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Parameter data type.
" + } + }, + "com.amazonaws.cloudformation#ParameterConstraints": { + "type": "structure", + "members": { + "AllowedValues": { + "target": "com.amazonaws.cloudformation#AllowedValues", + "traits": { + "smithy.api#documentation": "A list of values that are permitted for a parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of criteria that CloudFormation uses to validate parameter values. Although other constraints might be\n defined in the stack template, CloudFormation returns only the AllowedValues property.
The name that's associated with the parameter.
" + } + }, + "DefaultValue": { + "target": "com.amazonaws.cloudformation#ParameterValue", + "traits": { + "smithy.api#documentation": "The default value of the parameter.
" + } + }, + "ParameterType": { + "target": "com.amazonaws.cloudformation#ParameterType", + "traits": { + "smithy.api#documentation": "The type of parameter.
" + } + }, + "NoEcho": { + "target": "com.amazonaws.cloudformation#NoEcho", + "traits": { + "smithy.api#documentation": "Flag that indicates whether the parameter value is shown as plain text in logs and in the Amazon Web Services Management Console.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "The description that's associate with the parameter.
" + } + }, + "ParameterConstraints": { + "target": "com.amazonaws.cloudformation#ParameterConstraints", + "traits": { + "smithy.api#documentation": "The criteria that CloudFormation uses to validate parameter values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The ParameterDeclaration data type.
" + } + }, + "com.amazonaws.cloudformation#ParameterDeclarations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ParameterDeclaration" + } + }, + "com.amazonaws.cloudformation#ParameterKey": { + "type": "string" + }, + "com.amazonaws.cloudformation#ParameterType": { + "type": "string" + }, + "com.amazonaws.cloudformation#ParameterValue": { + "type": "string" + }, + "com.amazonaws.cloudformation#Parameters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Parameter" + } + }, + "com.amazonaws.cloudformation#PermissionModels": { + "type": "enum", + "members": { + "SERVICE_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICE_MANAGED" + } + }, + "SELF_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELF_MANAGED" + } + } + } + }, + "com.amazonaws.cloudformation#PhysicalResourceId": { + "type": "string" + }, + "com.amazonaws.cloudformation#PhysicalResourceIdContext": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#PhysicalResourceIdContextKeyValuePair" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudformation#PhysicalResourceIdContextKeyValuePair": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.cloudformation#Key", + "traits": { + "smithy.api#documentation": "The resource context key.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.cloudformation#Value", + "traits": { + "smithy.api#documentation": "The resource context value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a resource that contains the targeted resource.
" + } + }, + "com.amazonaws.cloudformation#PrivateTypeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+$" + } + }, + "com.amazonaws.cloudformation#Properties": { + "type": "string" + }, + "com.amazonaws.cloudformation#PropertyDifference": { + "type": "structure", + "members": { + "PropertyPath": { + "target": "com.amazonaws.cloudformation#PropertyPath", + "traits": { + "smithy.api#documentation": "The fully-qualified path to the resource property.
", + "smithy.api#required": {} + } + }, + "ExpectedValue": { + "target": "com.amazonaws.cloudformation#PropertyValue", + "traits": { + "smithy.api#documentation": "The expected property value of the resource property, as defined in the stack template and any values specified\n as template parameters.
", + "smithy.api#required": {} + } + }, + "ActualValue": { + "target": "com.amazonaws.cloudformation#PropertyValue", + "traits": { + "smithy.api#documentation": "The actual property value of the resource property.
", + "smithy.api#required": {} + } + }, + "DifferenceType": { + "target": "com.amazonaws.cloudformation#DifferenceType", + "traits": { + "smithy.api#documentation": "The type of property difference.
\n\n ADD: A value has been added to a resource property that's an array or list data type.
\n REMOVE: The property has been removed from the current resource configuration.
\n NOT_EQUAL: The current property value differs from its expected value (as defined in the stack\n template and any values specified as template parameters).
Information about a resource property whose actual value differs from its expected value, as defined in the\n stack template and any values specified as template parameters. These will be present only for resources whose\n StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
Publishes the specified extension to the CloudFormation registry as a public extension in this Region.\n Public extensions are available for use by all CloudFormation users. For more information about publishing\n extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI\n User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#PublishTypeInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#ThirdPartyType", + "traits": { + "smithy.api#documentation": "The type of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor\n version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
The Amazon Resource Name (ARN) assigned to the public extension upon publication.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#PublisherId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 40 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]{12,40}$" + } + }, + "com.amazonaws.cloudformation#PublisherName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#PublisherProfile": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(http:|https:)+[^\\s]+[\\w]$" + } + }, + "com.amazonaws.cloudformation#PublisherStatus": { + "type": "enum", + "members": { + "VERIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERIFIED" + } + }, + "UNVERIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNVERIFIED" + } + } + } + }, + "com.amazonaws.cloudformation#Reason": { + "type": "string" + }, + "com.amazonaws.cloudformation#RecordHandlerProgress": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#RecordHandlerProgressInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#RecordHandlerProgressOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidStateTransitionException" + }, + { + "target": "com.amazonaws.cloudformation#OperationStatusCheckFailedException" + } + ], + "traits": { + "smithy.api#documentation": "Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't\n use this API in your code.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#RecordHandlerProgressInput": { + "type": "structure", + "members": { + "BearerToken": { + "target": "com.amazonaws.cloudformation#ClientToken", + "traits": { + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", + "smithy.api#required": {} + } + }, + "OperationStatus": { + "target": "com.amazonaws.cloudformation#OperationStatus", + "traits": { + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", + "smithy.api#required": {} + } + }, + "CurrentOperationStatus": { + "target": "com.amazonaws.cloudformation#OperationStatus", + "traits": { + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.cloudformation#StatusMessage", + "traits": { + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + } + }, + "ErrorCode": { + "target": "com.amazonaws.cloudformation#HandlerErrorCode", + "traits": { + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + } + }, + "ResourceModel": { + "target": "com.amazonaws.cloudformation#ResourceModel", + "traits": { + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#RecordHandlerProgressOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#Region": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9-]{1,128}$" + } + }, + "com.amazonaws.cloudformation#RegionConcurrencyType": { + "type": "enum", + "members": { + "SEQUENTIAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEQUENTIAL" + } + }, + "PARALLEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARALLEL" + } + } + } + }, + "com.amazonaws.cloudformation#RegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Region" + } + }, + "com.amazonaws.cloudformation#RegisterPublisher": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#RegisterPublisherInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#RegisterPublisherOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + } + ], + "traits": { + "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public\n extensions are available for use by all CloudFormation users. This publisher ID applies to your account in\n all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#RegisterPublisherInput": { + "type": "structure", + "members": { + "AcceptTermsAndConditions": { + "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", + "traits": { + "smithy.api#documentation": "Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the\n terms and conditions in order to register to publish public extensions to the CloudFormation\n registry.
\nThe default is false.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#RegisterPublisherOutput": { + "type": "structure", + "members": { + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "The ID assigned this account by CloudFormation for publishing extensions.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#RegisterType": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#RegisterTypeInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#RegisterTypeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + } + ], + "traits": { + "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for\n use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use SetTypeConfiguration to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#RegisterTypeInput": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", + "traits": { + "smithy.api#documentation": "The kind of extension.
" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
A URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.
\nSpecifies logging configuration information for an extension.
" + } + }, + "ExecutionRoleArn": { + "target": "com.amazonaws.cloudformation#RoleARN2", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when\n invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust relationship\n with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more\n information about adding trust relationships, see Modifying a\n role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this\n execution role to create a temporary session token, which it then passes to the resource type handler, thereby\n supplying your resource type with the appropriate credentials.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#RequestToken", + "traits": { + "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same\n registration request, even if the request is submitted multiple times.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#RegisterTypeOutput": { + "type": "structure", + "members": { + "RegistrationToken": { + "target": "com.amazonaws.cloudformation#RegistrationToken", + "traits": { + "smithy.api#documentation": "The identifier for this registration request.
\nUse this registration token when calling DescribeTypeRegistration, which returns information\n about the status and IDs of the extension registration.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#RegistrationStatus": { + "type": "enum", + "members": { + "COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETE" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.cloudformation#RegistrationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" + } + }, + "com.amazonaws.cloudformation#RegistrationTokenList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#RegistrationToken" + } + }, + "com.amazonaws.cloudformation#RegistryType": { + "type": "enum", + "members": { + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + }, + "MODULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODULE" + } + }, + "HOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOOK" + } + } + } + }, + "com.amazonaws.cloudformation#Replacement": { + "type": "enum", + "members": { + "True": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "True" + } + }, + "False": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "False" + } + }, + "Conditional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Conditional" + } + } + } + }, + "com.amazonaws.cloudformation#RequestToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][-a-zA-Z0-9]*$" + } + }, + "com.amazonaws.cloudformation#RequiredActivatedType": { + "type": "structure", + "members": { + "TypeNameAlias": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "An alias assigned to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
" + } + }, + "OriginalTypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The type name of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
The publisher ID of the extension publisher.
" + } + }, + "SupportedMajorVersions": { + "target": "com.amazonaws.cloudformation#SupportedMajorVersions", + "traits": { + "smithy.api#documentation": "A list of the major versions of the extension type that the macro supports.
" + } + } + }, + "traits": { + "smithy.api#documentation": "For extensions that are modules, a public third-party extension that must be activated in your account in order\n for the module itself to be activated.
\nFor more information, see Activating public modules for use in your\n account in the CloudFormation User Guide.
" + } + }, + "com.amazonaws.cloudformation#RequiredActivatedTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#RequiredActivatedType" + } + }, + "com.amazonaws.cloudformation#RequiresRecreation": { + "type": "enum", + "members": { + "Never": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Never" + } + }, + "Conditionally": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Conditionally" + } + }, + "Always": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Always" + } + } + } + }, + "com.amazonaws.cloudformation#ResourceAttribute": { + "type": "enum", + "members": { + "Properties": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Properties" + } + }, + "Metadata": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Metadata" + } + }, + "CreationPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreationPolicy" + } + }, + "UpdatePolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UpdatePolicy" + } + }, + "DeletionPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeletionPolicy" + } + }, + "Tags": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tags" + } + } + } + }, + "com.amazonaws.cloudformation#ResourceChange": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.cloudformation#ChangeAction", + "traits": { + "smithy.api#documentation": "The action that CloudFormation takes on the resource, such as Add (adds a new resource),\n Modify (changes a resource), Remove (deletes a resource), Import (imports a\n resource), or Dynamic (exact action for the resource can't be determined).
The resource's logical ID, which is defined in the stack's template.
" + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they\n haven't been created.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "The type of CloudFormation resource, such as AWS::S3::Bucket.
For the Modify action, indicates whether CloudFormation will replace the resource by creating a\n new one and deleting the old one. This value depends on the value of the RequiresRecreation property in\n the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is\n Always and the Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always and the\n Evaluation field is Dynamic, Replacement is\n Conditionally.
If you have multiple changes with different RequiresRecreation values, the Replacement\n value depends on the change with the most impact. A RequiresRecreation value of Always has\n the most impact, followed by Conditionally, and then Never.
For the Modify action, indicates which resource attribute is triggering this update, such as a\n change in the resource attribute's Metadata, Properties, or Tags.
For the Modify action, a list of ResourceChangeDetail structures that describes the\n changes that CloudFormation will make to the resource.
The change set ID of the nested change set.
" + } + }, + "ModuleInfo": { + "target": "com.amazonaws.cloudformation#ModuleInfo", + "traits": { + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The ResourceChange structure describes the resource and the action that CloudFormation will\n perform on it if you execute this change set.
A ResourceTargetDefinition structure that describes the field that CloudFormation will change\n and whether the resource will be recreated.
Indicates whether CloudFormation can determine the target value, and whether the target value will change\n before you execute a change set.
\nFor Static evaluations, CloudFormation can determine that the target value will change, and its\n value. For example, if you directly modify the InstanceType property of an EC2 instance, CloudFormation knows that this property value will change, and its value, so this is a Static\n evaluation.
For Dynamic evaluations, can't determine the target value because it depends on the result of an\n intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is\n updated. For example, if your template includes a reference to a resource that's conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the\n resource is recreated, it will have a new physical ID, so all references to that resource will also be\n updated.
The group to which the CausingEntity value belongs. There are five entity groups:
\n ResourceReference entities are Ref intrinsic functions that refer to resources in the\n template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.
\n ParameterReference entities are Ref intrinsic functions that get template parameter\n values, such as { \"Ref\" : \"MyPasswordParameter\" }.
\n ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute\n values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.
\n DirectModification entities are changes that are made directly to the template.
\n Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as\n nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, CloudFormation\n sets the ChangeSource to Automatic because the nested stack's template might have\n changed. Changes to a nested stack's template aren't visible to CloudFormation until you run an update on the\n parent stack.
The identity of the entity that triggered this change. This entity is a member of the group that's specified by\n the ChangeSource field. For example, if you modified the value of the KeyPairName\n parameter, the CausingEntity is the name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification, no value is given for\n CausingEntity.
For a resource with Modify as the action, the ResourceChange structure describes the\n changes CloudFormation will make to that resource.
The template resource type of the target resources, such as AWS::S3::Bucket.
The logical IDs of the target resources of the specified ResourceType, as defined in the import\n template.
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources\n of that type.
Indicates which resource attribute is triggering this update, such as a change in the resource attribute's\n Metadata, Properties, or Tags.
If the Attribute value is Properties, the name of the property. For all other\n attributes, the value is null.
If the Attribute value is Properties, indicates whether a change to this property\n causes the resource to be recreated. The value can be Never, Always, or\n Conditionally. To determine the conditions for a Conditionally recreation, see the update\n behavior for that property in the\n CloudFormation User Guide.
The field that CloudFormation will change, such as the name of a resource's property, and whether the\n resource will be recreated.
" + } + }, + "com.amazonaws.cloudformation#ResourceToImport": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported\n resource types, see Resources that support import\n operations in the CloudFormation User Guide.
The logical ID of the target resource as specified in the template.
", + "smithy.api#required": {} + } + }, + "ResourceIdentifier": { + "target": "com.amazonaws.cloudformation#ResourceIdentifierProperties", + "traits": { + "smithy.api#documentation": "A key-value pair that identifies the target resource. The key is an identifier property (for example,\n BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for\n example, MyS3Bucket).
Describes the target resource of an import operation.
" + } + }, + "com.amazonaws.cloudformation#ResourceToSkip": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.cloudformation#ResourceType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudformation#ResourceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ResourceType" + } + }, + "com.amazonaws.cloudformation#ResourcesToImport": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ResourceToImport" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cloudformation#ResourcesToSkip": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ResourceToSkip" + } + }, + "com.amazonaws.cloudformation#RetainExceptOnCreate": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#RetainResources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#LogicalResourceId" + } + }, + "com.amazonaws.cloudformation#RetainStacks": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.cloudformation#RetainStacksNullable": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#RetainStacksOnAccountRemovalNullable": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#RoleARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.cloudformation#RoleARN2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:.+:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.cloudformation#RollbackConfiguration": { + "type": "structure", + "members": { + "RollbackTriggers": { + "target": "com.amazonaws.cloudformation#RollbackTriggers", + "traits": { + "smithy.api#documentation": "The triggers to monitor during stack creation or update actions.
\nBy default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update\n operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those\n triggers replace any list of triggers previously specified for the stack. This means:
\nTo use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
\nTo specify new or updated rollback triggers, you must specify all the triggers that you\n want used for this stack, even triggers you've specified before (for example, when creating the stack or during a\n previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied\n to the stack.
\nTo remove all currently specified triggers, specify an empty list for this parameter.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.
" + } + }, + "MonitoringTimeInMinutes": { + "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", + "traits": { + "smithy.api#documentation": "The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers\n after the stack creation or update operation deploys all necessary resources.
\nThe default is 0 minutes.
\nIf you specify a monitoring period but don't specify any rollback triggers, CloudFormation still waits\n the specified period of time before cleaning up old resources after update operations. You can use this monitoring\n period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.
\nIf you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers\n during stack creation and update operations. Then, for update operations, it begins disposing of old resources\n immediately once the operation completes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Structure containing the rollback triggers for CloudFormation to monitor during stack creation and updating operations,\n and for the specified monitoring period afterwards.
\nRollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and\n updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've\n specified. For more information, see Monitor and Roll Back Stack\n Operations.
" + } + }, + "com.amazonaws.cloudformation#RollbackStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#RollbackStackInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#RollbackStackOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
The name that's associated with the stack.
", + "smithy.api#required": {} + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the\n stack.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A unique identifier for this RollbackStack request.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
Unique identifier of the stack.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#RollbackTrigger": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rollback trigger.
\nIf a specified trigger is missing, the entire stack operation fails and is rolled back.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.cloudformation#Type", + "traits": { + "smithy.api#documentation": "The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A rollback trigger CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes\n to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.
" + } + }, + "com.amazonaws.cloudformation#RollbackTriggers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#RollbackTrigger" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.cloudformation#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#S3Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.cloudformation#Scope": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#ResourceAttribute" + } + }, + "com.amazonaws.cloudformation#SetStackPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#SetStackPolicyInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Sets a stack policy for a specified stack.
" + } + }, + "com.amazonaws.cloudformation#SetStackPolicyInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name or unique stack ID that you want to associate a policy with.
", + "smithy.api#required": {} + } + }, + "StackPolicyBody": { + "target": "com.amazonaws.cloudformation#StackPolicyBody", + "traits": { + "smithy.api#documentation": "Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not both.
The input for the SetStackPolicy action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#SetTypeConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#SetTypeConfigurationInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#SetTypeConfigurationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#CFNRegistryException" + }, + { + "target": "com.amazonaws.cloudformation#TypeNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Specifies the configuration data for a registered CloudFormation extension, in the given account and\n Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of DescribeType. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User\n Guide.
\nThe Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.
" + } + }, + "Configuration": { + "target": "com.amazonaws.cloudformation#TypeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of DescribeType. For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
An alias by which to refer to this extension configuration data.
\nConditional: Specifying a configuration alias is required when setting a configuration for a resource type\n extension.
" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The name of the extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The type of extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudformation#SetTypeDefaultVersionInput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#PrivateTypeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#SetTypeDefaultVersionOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#SignalResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#SignalResourceInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation\n doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout\n period is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
The stack name or unique stack ID that includes the resource that you want to signal.
", + "smithy.api#required": {} + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in\n the template.
", + "smithy.api#required": {} + } + }, + "UniqueId": { + "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", + "traits": { + "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as\n signaling a wait condition), each signal requires a different unique ID.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#ResourceSignalStatus", + "traits": { + "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes CloudFormation to\n immediately fail the stack creation or update.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the SignalResource action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#Stack": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "Unique identifier of the stack.
" + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name associated with the stack.
", + "smithy.api#required": {} + } + }, + "ChangeSetId": { + "target": "com.amazonaws.cloudformation#ChangeSetId", + "traits": { + "smithy.api#documentation": "The unique ID of the change set.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "A user-defined description associated with the stack.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of Parameter structures.
The time at which the stack was created.
", + "smithy.api#required": {} + } + }, + "DeletionTime": { + "target": "com.amazonaws.cloudformation#DeletionTime", + "traits": { + "smithy.api#documentation": "The time the stack was deleted.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudformation#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
" + } + }, + "RollbackConfiguration": { + "target": "com.amazonaws.cloudformation#RollbackConfiguration", + "traits": { + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" + } + }, + "StackStatus": { + "target": "com.amazonaws.cloudformation#StackStatus", + "traits": { + "smithy.api#documentation": "Current status of the stack.
", + "smithy.api#required": {} + } + }, + "StackStatusReason": { + "target": "com.amazonaws.cloudformation#StackStatusReason", + "traits": { + "smithy.api#documentation": "Success/failure message associated with the stack status.
" + } + }, + "DisableRollback": { + "target": "com.amazonaws.cloudformation#DisableRollback", + "traits": { + "smithy.api#documentation": "Boolean to enable or disable rollback on stack creation failures:
\n\n true: disable rollback.
\n false: enable rollback.
Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.
" + } + }, + "TimeoutInMinutes": { + "target": "com.amazonaws.cloudformation#TimeoutMinutes", + "traits": { + "smithy.api#documentation": "The amount of time within which stack creation should complete.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "The capabilities allowed in the stack.
" + } + }, + "Outputs": { + "target": "com.amazonaws.cloudformation#Outputs", + "traits": { + "smithy.api#documentation": "A list of output structures.
" + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the\n stack. During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
" + } + }, + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", + "traits": { + "smithy.api#documentation": "A list of Tags that specify information about the stack.
Whether termination protection is enabled for the stack.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested stack.\n For more information, see Protecting a Stack From Being Deleted\n in the CloudFormation User Guide.
" + } + }, + "ParentId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + } + }, + "RootId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + } + }, + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackDriftInformation", + "traits": { + "smithy.api#documentation": "Information about whether a stack's actual configuration differs, or has drifted, from its\n expected configuration, as defined in the stack template and any values specified as template parameters. For more\n information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + } + }, + "RetainExceptOnCreate": { + "target": "com.amazonaws.cloudformation#RetainExceptOnCreate", + "traits": { + "smithy.api#documentation": "When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
The Stack data type.
" + } + }, + "com.amazonaws.cloudformation#StackDriftDetectionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.cloudformation#StackDriftDetectionStatus": { + "type": "enum", + "members": { + "DETECTION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETECTION_IN_PROGRESS" + } + }, + "DETECTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETECTION_FAILED" + } + }, + "DETECTION_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETECTION_COMPLETE" + } + } + } + }, + "com.amazonaws.cloudformation#StackDriftDetectionStatusReason": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackDriftInformation": { + "type": "structure", + "members": { + "StackDriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.
" + } + }, + "com.amazonaws.cloudformation#StackDriftInformationSummary": { + "type": "structure", + "members": { + "StackDriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected template configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources\n that support drift detection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about whether the stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. A stack is considered to have drifted if one or more of its resources have\n drifted.
" + } + }, + "com.amazonaws.cloudformation#StackDriftStatus": { + "type": "enum", + "members": { + "DRIFTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIFTED" + } + }, + "IN_SYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_SYNC" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + }, + "NOT_CHECKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CHECKED" + } + } + } + }, + "com.amazonaws.cloudformation#StackEvent": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The unique ID name of the instance of the stack.
", + "smithy.api#required": {} + } + }, + "EventId": { + "target": "com.amazonaws.cloudformation#EventId", + "traits": { + "smithy.api#documentation": "The unique ID of this event.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name associated with a stack.
", + "smithy.api#required": {} + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource specified in the template.
" + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The name or unique identifier associated with the physical instance of the resource.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
" + } + }, + "Timestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "Time the status was updated.
", + "smithy.api#required": {} + } + }, + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", + "traits": { + "smithy.api#documentation": "Current status of the resource.
" + } + }, + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "traits": { + "smithy.api#documentation": "Success/failure message associated with the resource.
" + } + }, + "ResourceProperties": { + "target": "com.amazonaws.cloudformation#ResourceProperties", + "traits": { + "smithy.api#documentation": "BLOB of the properties used to create the resource.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The token passed to the operation that generated this event.
\nAll events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
The name of the hook.
" + } + }, + "HookStatus": { + "target": "com.amazonaws.cloudformation#HookStatus", + "traits": { + "smithy.api#documentation": "Provides the status of the change set hook.
" + } + }, + "HookStatusReason": { + "target": "com.amazonaws.cloudformation#HookStatusReason", + "traits": { + "smithy.api#documentation": "Provides the reason for the hook status.
" + } + }, + "HookInvocationPoint": { + "target": "com.amazonaws.cloudformation#HookInvocationPoint", + "traits": { + "smithy.api#documentation": "Invocation points are points in provisioning logic where hooks are initiated.
" + } + }, + "HookFailureMode": { + "target": "com.amazonaws.cloudformation#HookFailureMode", + "traits": { + "smithy.api#documentation": "Specify the hook failure mode for non-compliant resources in the followings ways.
\n\n FAIL Stops provisioning resources.
\n WARN Allows provisioning to continue with a warning message.
The StackEvent data type.
" + } + }, + "com.amazonaws.cloudformation#StackEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackEvent" + } + }, + "com.amazonaws.cloudformation#StackId": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackId" + } + }, + "com.amazonaws.cloudformation#StackIdsUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5120 + }, + "smithy.api#pattern": "^(s3://|http(s?)://).+$" + } + }, + "com.amazonaws.cloudformation#StackInstance": { + "type": "structure", + "members": { + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that the stack instance is associated with.
" + } + }, + "Region": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated with.
" + } + }, + "Account": { + "target": "com.amazonaws.cloudformation#Account", + "traits": { + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The ID of the stack instance.
" + } + }, + "ParameterOverrides": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of parameters from the stack set template whose values have been overridden in this stack\n instance.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#StackInstanceStatus", + "traits": { + "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The detailed status of the stack instance.
" + } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#Reason", + "traits": { + "smithy.api#documentation": "The explanation for the specific status code that's assigned to this stack instance.
" + } + }, + "OrganizationalUnitId": { + "target": "com.amazonaws.cloudformation#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" + } + }, + "DriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This\n value will be NULL for any stack instance on which drift detection hasn't yet been performed.
The last unique ID of a StackSet operation performed on a stack instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack\n instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance\n can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is\n associated with only one stack set. Each stack instance contains the ID of its associated stack set, in addition to\n the ID of the actual stack and the stack status.
" + } + }, + "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { + "type": "structure", + "members": { + "DetailedStatus": { + "target": "com.amazonaws.cloudformation#StackInstanceDetailedStatus", + "traits": { + "smithy.api#documentation": "\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the stack set operation\n fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be\n exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to start.
\n RUNNING: The operation in the specified account and Region is currently in progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped\n because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The detailed status of the stack instance.
" + } + }, + "com.amazonaws.cloudformation#StackInstanceDetailedStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "INOPERABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INOPERABLE" + } + }, + "SKIPPED_SUSPENDED_ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SKIPPED_SUSPENDED_ACCOUNT" + } + } + } + }, + "com.amazonaws.cloudformation#StackInstanceFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudformation#StackInstanceFilterName", + "traits": { + "smithy.api#documentation": "The type of filter to apply.
" + } + }, + "Values": { + "target": "com.amazonaws.cloudformation#StackInstanceFilterValues", + "traits": { + "smithy.api#documentation": "The status to filter by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The filter to apply to stack instances
" + } + }, + "com.amazonaws.cloudformation#StackInstanceFilterName": { + "type": "enum", + "members": { + "DETAILED_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETAILED_STATUS" + } + }, + "LAST_OPERATION_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST_OPERATION_ID" + } + }, + "DRIFT_STATUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIFT_STATUS" + } + } + } + }, + "com.amazonaws.cloudformation#StackInstanceFilterValues": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^\\S{1,128}$" + } + }, + "com.amazonaws.cloudformation#StackInstanceFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackInstanceFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.cloudformation#StackInstanceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StackInstanceNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified stack instance doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummary" + } + }, + "com.amazonaws.cloudformation#StackInstanceResourceDriftsSummary": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The ID of the stack instance.
", + "smithy.api#required": {} + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource specified in the template.
", + "smithy.api#required": {} + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
" + } + }, + "PhysicalResourceIdContext": { + "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", + "traits": { + "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses\n context key-value pairs in cases where a resource's logical and physical IDs aren't enough\n to uniquely identify that resource. Each context key-value pair specifies a unique resource\n that contains the targeted resource.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.
", + "smithy.api#required": {} + } + }, + "PropertyDifferences": { + "target": "com.amazonaws.cloudformation#PropertyDifferences", + "traits": { + "smithy.api#documentation": "Status of the actual configuration of the resource compared to its expected\n configuration. These will be present only for resources whose\n StackInstanceResourceDriftStatus is MODIFIED.
The drift status of the resource in a stack instance.
\n\n DELETED: The resource differs from its expected template\n configuration in that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
Time at which the stack instance drift detection operation was initiated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The structure containing summary information about resource drifts for a stack\n instance.
" + } + }, + "com.amazonaws.cloudformation#StackInstanceStatus": { + "type": "enum", + "members": { + "CURRENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENT" + } + }, + "OUTDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTDATED" + } + }, + "INOPERABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INOPERABLE" + } + } + } + }, + "com.amazonaws.cloudformation#StackInstanceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackInstanceSummary" + } + }, + "com.amazonaws.cloudformation#StackInstanceSummary": { + "type": "structure", + "members": { + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that the stack instance is associated with.
" + } + }, + "Region": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "The name of the Amazon Web Services Region that the stack instance is associated with.
" + } + }, + "Account": { + "target": "com.amazonaws.cloudformation#Account", + "traits": { + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated\n with.
" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The ID of the stack instance.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#StackInstanceStatus", + "traits": { + "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED: The stack isn't currently up to date with the stack set because:
The associated stack failed during a CreateStackSet or UpdateStackSet\n operation.
The stack was part of a CreateStackSet or UpdateStackSet operation that failed or\n was stopped before the stack was created or updated.
\n CURRENT: The stack is currently up to date with the stack set.
The explanation for the specific status code assigned to this stack instance.
" + } + }, + "StackInstanceStatus": { + "target": "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus", + "traits": { + "smithy.api#documentation": "The detailed status of the stack instance.
" + } + }, + "OrganizationalUnitId": { + "target": "com.amazonaws.cloudformation#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" + } + }, + "DriftStatus": { + "target": "com.amazonaws.cloudformation#StackDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the stack instance's actual configuration compared to the expected template and parameter\n configuration of the stack set to which it belongs.
\n\n DRIFTED: The stack differs from the expected template and parameter configuration of the stack\n set to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the\n associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack instance differs from its expected stack set\n configuration.
\n IN_SYNC: The stack instance's actual configuration matches its expected stack set\n configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack instance. This\n value will be NULL for any stack instance on which drift detection hasn't yet been performed.
The last unique ID of a StackSet operation performed on a stack instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure that contains summary information about a stack instance.
" + } + }, + "com.amazonaws.cloudformation#StackName": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackNameOrId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)$" + } + }, + "com.amazonaws.cloudformation#StackNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StackNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified stack ARN doesn't exist or stack doesn't exist corresponding to the ARN in input.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudformation#StackPolicyBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.cloudformation#StackPolicyDuringUpdateBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16384 + } + } + }, + "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1350 + } + } + }, + "com.amazonaws.cloudformation#StackPolicyURL": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1350 + } + } + }, + "com.amazonaws.cloudformation#StackResource": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name associated with the stack.
" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "Unique identifier of the stack.
" + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource specified in the template.
", + "smithy.api#required": {} + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#required": {} + } + }, + "Timestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "Time the status was updated.
", + "smithy.api#required": {} + } + }, + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", + "traits": { + "smithy.api#documentation": "Current status of the resource.
", + "smithy.api#required": {} + } + }, + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "traits": { + "smithy.api#documentation": "Success/failure message associated with the resource.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "User defined description associated with the resource.
" + } + }, + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackResourceDriftInformation", + "traits": { + "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + } + }, + "ModuleInfo": { + "target": "com.amazonaws.cloudformation#ModuleInfo", + "traits": { + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The StackResource data type.
" + } + }, + "com.amazonaws.cloudformation#StackResourceDetail": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name associated with the stack.
" + } + }, + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "Unique identifier of the stack.
" + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource specified in the template.
", + "smithy.api#required": {} + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "Type of resource. For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.
", + "smithy.api#required": {} + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "Time the status was updated.
", + "smithy.api#required": {} + } + }, + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", + "traits": { + "smithy.api#documentation": "Current status of the resource.
", + "smithy.api#required": {} + } + }, + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "traits": { + "smithy.api#documentation": "Success/failure message associated with the resource.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "User defined description associated with the resource.
" + } + }, + "Metadata": { + "target": "com.amazonaws.cloudformation#Metadata", + "traits": { + "smithy.api#documentation": "The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute\n in the CloudFormation User Guide.
Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + } + }, + "ModuleInfo": { + "target": "com.amazonaws.cloudformation#ModuleInfo", + "traits": { + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains detailed information about the specified stack resource.
" + } + }, + "com.amazonaws.cloudformation#StackResourceDrift": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The ID of the stack.
", + "smithy.api#required": {} + } + }, + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource specified in the template.
", + "smithy.api#required": {} + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by\n CloudFormation.
" + } + }, + "PhysicalResourceIdContext": { + "target": "com.amazonaws.cloudformation#PhysicalResourceIdContext", + "traits": { + "smithy.api#documentation": "Context information that enables CloudFormation to uniquely identify a resource. CloudFormation uses context key-value pairs in\n cases where a resource's logical and physical IDs aren't enough to uniquely identify that resource. Each context\n key-value pair specifies a unique resource that contains the targeted resource.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource.
", + "smithy.api#required": {} + } + }, + "ExpectedProperties": { + "target": "com.amazonaws.cloudformation#Properties", + "traits": { + "smithy.api#documentation": "A JSON structure containing the expected property values of the stack resource, as defined in the stack template\n and any values specified as template parameters.
\nFor resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.
A JSON structure containing the actual property values of the stack resource.
\nFor resources whose StackResourceDriftStatus is DELETED, this structure will not be\n present.
A collection of the resource properties whose actual values differ from their expected values. These will be\n present only for resources whose StackResourceDriftStatus is\n MODIFIED.
Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected template configuration because the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected values (as defined in the\n stack template and any values specified as template parameters).
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation does not currently return this value.
Time at which CloudFormation performed drift detection on the stack resource.
", + "smithy.api#required": {} + } + }, + "ModuleInfo": { + "target": "com.amazonaws.cloudformation#ModuleInfo", + "traits": { + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the drift information for a resource that has been checked for drift. This includes actual and expected\n property values for resources in which CloudFormation has detected drift. Only resource properties explicitly defined in the\n stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nResources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
" + } + }, + "com.amazonaws.cloudformation#StackResourceDriftInformation": { + "type": "structure", + "members": { + "StackResourceDriftStatus": { + "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation has not checked if the resource differs from its expected\n configuration.
Any resources that do not currently support drift detection have a status of NOT_CHECKED. For\n more information, see Resources that Support Drift\n Detection.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
When CloudFormation last checked if the resource had drifted from its expected configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + } + }, + "com.amazonaws.cloudformation#StackResourceDriftInformationSummary": { + "type": "structure", + "members": { + "StackResourceDriftStatus": { + "target": "com.amazonaws.cloudformation#StackResourceDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the resource's actual configuration compared to its expected configuration.
\n\n DELETED: The resource differs from its expected configuration in that it has been deleted.
\n MODIFIED: The resource differs from its expected configuration.
\n NOT_CHECKED: CloudFormation hasn't checked if the resource differs from its expected configuration.
Any resources that don't currently support drift detection have a status of NOT_CHECKED. For more\n information, see Resources that Support Drift\n Detection. If you performed an ContinueUpdateRollback operation on a stack, any\n resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more\n information about skipping resources during rollback operations, see Continue Rolling\n Back an Update in the CloudFormation User Guide.
\n IN_SYNC: The resource's actual configuration matches its expected configuration.
When CloudFormation last checked if the resource had drifted from its expected configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summarizes information about whether the resource's actual configuration differs, or has\n drifted, from its expected configuration.
" + } + }, + "com.amazonaws.cloudformation#StackResourceDriftStatus": { + "type": "enum", + "members": { + "IN_SYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_SYNC" + } + }, + "MODIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODIFIED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "NOT_CHECKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CHECKED" + } + } + } + }, + "com.amazonaws.cloudformation#StackResourceDriftStatusFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackResourceDriftStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.cloudformation#StackResourceDrifts": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackResourceDrift" + } + }, + "com.amazonaws.cloudformation#StackResourceSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackResourceSummary" + } + }, + "com.amazonaws.cloudformation#StackResourceSummary": { + "type": "structure", + "members": { + "LogicalResourceId": { + "target": "com.amazonaws.cloudformation#LogicalResourceId", + "traits": { + "smithy.api#documentation": "The logical name of the resource specified in the template.
", + "smithy.api#required": {} + } + }, + "PhysicalResourceId": { + "target": "com.amazonaws.cloudformation#PhysicalResourceId", + "traits": { + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of the resource.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.cloudformation#ResourceType", + "traits": { + "smithy.api#documentation": "Type of resource. (For more information, go to Amazon Web Services Resource Types\n Reference in the CloudFormation User Guide.)
", + "smithy.api#required": {} + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "Time the status was updated.
", + "smithy.api#required": {} + } + }, + "ResourceStatus": { + "target": "com.amazonaws.cloudformation#ResourceStatus", + "traits": { + "smithy.api#documentation": "Current status of the resource.
", + "smithy.api#required": {} + } + }, + "ResourceStatusReason": { + "target": "com.amazonaws.cloudformation#ResourceStatusReason", + "traits": { + "smithy.api#documentation": "Success/failure message associated with the resource.
" + } + }, + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackResourceDriftInformationSummary", + "traits": { + "smithy.api#documentation": "Information about whether the resource's actual configuration differs, or has drifted, from\n its expected configuration, as defined in the stack template and any values specified as template parameters. For\n more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
" + } + }, + "ModuleInfo": { + "target": "com.amazonaws.cloudformation#ModuleInfo", + "traits": { + "smithy.api#documentation": "Contains information about the module from which the resource was created, if the resource was created from a\n module included in the stack template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains high-level information about the specified stack resource.
" + } + }, + "com.amazonaws.cloudformation#StackResources": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackResource" + } + }, + "com.amazonaws.cloudformation#StackSet": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name that's associated with the stack set.
" + } + }, + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "The ID of the stack set.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#StackSetStatus", + "traits": { + "smithy.api#documentation": "The status of the stack set.
" + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "The structure that contains the body of the template that was used to create or update the stack set.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of input parameters for a stack set.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "The capabilities that are allowed in the stack set. Some stack set templates might include resources that can\n affect permissions in your Amazon Web Services account—for example, by creating new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM\n Resources in CloudFormation Templates.\n
" + } + }, + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", + "traits": { + "smithy.api#documentation": "A list of tags that specify information about the stack set. A maximum number of 50 tags can be\n specified.
" + } + }, + "StackSetARN": { + "target": "com.amazonaws.cloudformation#StackSetARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the stack set.
" + } + }, + "AdministrationRoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to create or update the stack set.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations\n in the CloudFormation User Guide.
" + } + }, + "ExecutionRoleName": { + "target": "com.amazonaws.cloudformation#ExecutionRoleName", + "traits": { + "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" + } + }, + "StackSetDriftDetectionDetails": { + "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations currently in progress isn't included.
" + } + }, + "AutoDeployment": { + "target": "com.amazonaws.cloudformation#AutoDeployment", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
" + } + }, + "PermissionModel": { + "target": "com.amazonaws.cloudformation#PermissionModels", + "traits": { + "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" + } + }, + "ManagedExecution": { + "target": "com.amazonaws.cloudformation#ManagedExecution", + "traits": { + "smithy.api#documentation": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" + } + }, + "Regions": { + "target": "com.amazonaws.cloudformation#RegionList", + "traits": { + "smithy.api#documentation": "Returns a list of all Amazon Web Services Regions the given StackSet has stack instances deployed in. The Amazon Web Services Regions list output is in no particular order.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about a stack set. A stack set enables you to provision stacks into\n Amazon Web Services accounts and across Regions by using a single CloudFormation template. In the stack set,\n you specify the template to use, in addition to any parameters and capabilities that the template requires.
" + } + }, + "com.amazonaws.cloudformation#StackSetARN": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackSetDriftDetectionDetails": { + "type": "structure", + "members": { + "DriftStatus": { + "target": "com.amazonaws.cloudformation#StackSetDriftStatus", + "traits": { + "smithy.api#documentation": "Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
The status of the stack set drift detection operation.
\n\n COMPLETED: The drift detection operation completed without failing on any stack instances.
\n FAILED: The drift detection operation exceeded the specified failure tolerance.
\n PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance\n for the operation.
\n IN_PROGRESS: The drift detection operation is currently being performed.
\n STOPPED: The user has canceled the drift detection operation.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value\n will be NULL for any stack set on which drift detection hasn't yet been performed.
The total number of stack instances belonging to this stack set.
\nThe total number of stack instances is equal to the total of:
\nStack instances that match the stack set configuration.
\nStack instances that have drifted from the stack set configuration.
\nStack instances where the drift detection operation has failed.
\nStack instances currently being checked for drift.
\nThe number of stack instances that have drifted from the expected template and parameter configuration of the\n stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack\n don't match their expected configuration.
" + } + }, + "InSyncStackInstancesCount": { + "target": "com.amazonaws.cloudformation#InSyncStackInstancesCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of stack instances which match the expected template and parameter configuration of the stack\n set.
" + } + }, + "InProgressStackInstancesCount": { + "target": "com.amazonaws.cloudformation#InProgressStackInstancesCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of stack instances that are currently being checked for drift.
" + } + }, + "FailedStackInstancesCount": { + "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of stack instances for which the drift detection operation failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about the drift status of the stack set.
\nFor stack sets, contains information about the last completed drift operation performed on\n the stack set. Information about drift operations in-progress isn't included.
\nFor stack set operations, includes information about drift operations currently being performed on the stack\n set.
\nFor more information, see Detecting unmanaged changes in stack sets in\n the CloudFormation User Guide.
" + } + }, + "com.amazonaws.cloudformation#StackSetDriftDetectionStatus": { + "type": "enum", + "members": { + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "PARTIAL_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL_SUCCESS" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.cloudformation#StackSetDriftStatus": { + "type": "enum", + "members": { + "DRIFTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRIFTED" + } + }, + "IN_SYNC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_SYNC" + } + }, + "NOT_CHECKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CHECKED" + } + } + } + }, + "com.amazonaws.cloudformation#StackSetId": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackSetName": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackSetNameOrId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?$" + } + }, + "com.amazonaws.cloudformation#StackSetNotEmptyException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StackSetNotEmptyException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack\n instances from the stack set before deleting the stack set.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudformation#StackSetNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StackSetNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified stack set doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudformation#StackSetOperation": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique ID of a stack set operation.
" + } + }, + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "The ID of the stack set.
" + } + }, + "Action": { + "target": "com.amazonaws.cloudformation#StackSetOperationAction", + "traits": { + "smithy.api#documentation": "The type of stack set operation: CREATE, UPDATE, or DELETE. Create and\n delete operations affect only the specified stack set instances that are associated with the specified stack set.\n Update operations affect both the stack set itself, in addition to all associated stack set\n instances.
The status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The preferences for how CloudFormation performs this stack set operation.
" + } + }, + "RetainStacks": { + "target": "com.amazonaws.cloudformation#RetainStacksNullable", + "traits": { + "smithy.api#documentation": "For stack set operations of action type DELETE, specifies whether to remove the stack instances\n from the specified stack set, but doesn't delete the stacks. You can't re-associate a retained stack, or add an\n existing, saved stack to a new stack set.
The Amazon Resource Name (ARN) of the IAM role used to perform this stack set operation.
\nUse customized administrator roles to control which users or groups can manage specific stack sets within the\n same administrator account. For more information, see Define Permissions for Multiple Administrators in the\n CloudFormation User Guide.
" + } + }, + "ExecutionRoleName": { + "target": "com.amazonaws.cloudformation#ExecutionRoleName", + "traits": { + "smithy.api#documentation": "The name of the IAM execution role used to create or update the stack set.
\nUse customized execution roles to control which stack resources users and groups can include in their stack\n sets.
" + } + }, + "CreationTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to\n perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.
" + } + }, + "EndTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" + } + }, + "DeploymentTargets": { + "target": "com.amazonaws.cloudformation#DeploymentTargets", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts affected by the stack operation.
" + } + }, + "StackSetDriftDetectionDetails": { + "target": "com.amazonaws.cloudformation#StackSetDriftDetectionDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the drift status of the stack set. This includes information about drift operations\n currently being performed on the stack set.
\nThis information will only be present for stack set operations whose Action type is\n DETECT_DRIFT.
For more information, see Detecting Unmanaged Changes in Stack Sets in\n the CloudFormation User Guide.
" + } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", + "traits": { + "smithy.api#documentation": "The status of the operation in details.
" + } + }, + "StatusDetails": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the StackSet operation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure that contains information about a stack set operation.
" + } + }, + "com.amazonaws.cloudformation#StackSetOperationAction": { + "type": "enum", + "members": { + "CREATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE" + } + }, + "UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE" + } + }, + "DELETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE" + } + }, + "DETECT_DRIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETECT_DRIFT" + } + } + } + }, + "com.amazonaws.cloudformation#StackSetOperationPreferences": { + "type": "structure", + "members": { + "RegionConcurrencyType": { + "target": "com.amazonaws.cloudformation#RegionConcurrencyType", + "traits": { + "smithy.api#documentation": "The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a\n time.
" + } + }, + "RegionOrder": { + "target": "com.amazonaws.cloudformation#RegionList", + "traits": { + "smithy.api#documentation": "The order of the Regions where you want to perform the stack operation.
" + } + }, + "FailureToleranceCount": { + "target": "com.amazonaws.cloudformation#FailureToleranceCount", + "traits": { + "smithy.api#documentation": "The number of accounts, per Region, for which this operation can fail before CloudFormation stops the\n operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation\n in any subsequent Regions.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).
By default, 0 is specified.
The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops\n the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the\n operation in any subsequent Regions.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds\n down to the next whole number.
\nConditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.
By default, 0 is specified.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of\n FailureToleranceCount.MaxConcurrentCount is at most one more than the\n FailureToleranceCount.
Note that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, CloudFormation rounds down to\n the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.
\nNote that this setting lets you specify the maximum for operations. For large deployments,\n under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service\n throttling.
\nConditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage,\n but not both.
By default, 1 is specified.
The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + } + }, + "com.amazonaws.cloudformation#StackSetOperationResultStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.cloudformation#StackSetOperationResultSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackSetOperationResultSummary" + } + }, + "com.amazonaws.cloudformation#StackSetOperationResultSummary": { + "type": "structure", + "members": { + "Account": { + "target": "com.amazonaws.cloudformation#Account", + "traits": { + "smithy.api#documentation": "[Self-managed permissions] The name of the Amazon Web Services account for this operation result.
" + } + }, + "Region": { + "target": "com.amazonaws.cloudformation#Region", + "traits": { + "smithy.api#documentation": "The name of the Amazon Web Services Region for this operation result.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#StackSetOperationResultStatus", + "traits": { + "smithy.api#documentation": "The result status of the stack set operation for the given account in the given Region.
\n\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed.
If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set\n operation as a whole might be exceeded.
\n\n RUNNING: The operation in the specified account and Region is currently in progress.
\n PENDING: The operation in the specified account and Region has yet to start.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The reason for the assigned result status.
" + } + }, + "AccountGateResult": { + "target": "com.amazonaws.cloudformation#AccountGateResult", + "traits": { + "smithy.api#documentation": "The results of the account gate function CloudFormation invokes, if present, before proceeding with stack\n set operations in an account.
" + } + }, + "OrganizationalUnitId": { + "target": "com.amazonaws.cloudformation#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for\n DeploymentTargets.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure that contains information about a specified operation's results for a given account in a given\n Region.
" + } + }, + "com.amazonaws.cloudformation#StackSetOperationStatus": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCEEDED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + } + } + }, + "com.amazonaws.cloudformation#StackSetOperationStatusDetails": { + "type": "structure", + "members": { + "FailedStackInstancesCount": { + "target": "com.amazonaws.cloudformation#FailedStackInstancesCount", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of stack instances for which the StackSet operation failed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information about the StackSet operation.
" + } + }, + "com.amazonaws.cloudformation#StackSetOperationStatusReason": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackSetOperationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackSetOperationSummary" + } + }, + "com.amazonaws.cloudformation#StackSetOperationSummary": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique ID of the stack set operation.
" + } + }, + "Action": { + "target": "com.amazonaws.cloudformation#StackSetOperationAction", + "traits": { + "smithy.api#documentation": "The type of operation: CREATE, UPDATE, or DELETE. Create and delete\n operations affect only the specified stack instances that are associated with the specified stack set. Update\n operations affect both the stack set itself and all associated stack set instances.
The overall status of the operation.
\n\n FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that\n you've set for an operation is applied for each Region during stack create and update operations. If the number of\n failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to\n FAILED. This in turn sets the status of the operation as a whole to FAILED, and CloudFormation cancels the operation in any remaining Regions.
\n QUEUED: [Service-managed permissions] For automatic deployments that require a sequence of\n operations, the operation is queued to be performed. For more information, see the stack set operation status\n codes in the CloudFormation User Guide.
\n RUNNING: The operation is currently being performed.
\n STOPPED: The user has canceled the operation.
\n STOPPING: The operation is in the process of stopping, at user request.
\n SUCCEEDED: The operation completed creating or updating all the specified stacks without\n exceeding the failure tolerance for the operation.
The time at which the operation was initiated. Note that the creation times for the stack set operation might\n differ from the creation time of the individual stacks themselves. This is because CloudFormation needs to\n perform preparatory work for the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.
" + } + }, + "EndTimestamp": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the stack set operation ended, across all accounts and Regions specified. Note that this\n doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or\n Region.
" + } + }, + "StatusReason": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusReason", + "traits": { + "smithy.api#documentation": "The status of the operation in details.
" + } + }, + "StatusDetails": { + "target": "com.amazonaws.cloudformation#StackSetOperationStatusDetails", + "traits": { + "smithy.api#documentation": "Detailed information about the stack set operation.
" + } + }, + "OperationPreferences": { + "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", + "traits": { + "smithy.api#documentation": "The user-specified preferences for how CloudFormation performs a stack set operation.
\nFor more information about maximum concurrent accounts and failure tolerance, see Stack set operation\n options.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structures that contain summary information about the specified operation.
" + } + }, + "com.amazonaws.cloudformation#StackSetStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.cloudformation#StackSetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackSetSummary" + } + }, + "com.amazonaws.cloudformation#StackSetSummary": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name of the stack set.
" + } + }, + "StackSetId": { + "target": "com.amazonaws.cloudformation#StackSetId", + "traits": { + "smithy.api#documentation": "The ID of the stack set.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "A description of the stack set that you specify when the stack set is created or updated.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudformation#StackSetStatus", + "traits": { + "smithy.api#documentation": "The status of the stack set.
" + } + }, + "AutoDeployment": { + "target": "com.amazonaws.cloudformation#AutoDeployment", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organizational unit (OU).
" + } + }, + "PermissionModel": { + "target": "com.amazonaws.cloudformation#PermissionModels", + "traits": { + "smithy.api#documentation": "Describes how the IAM roles required for stack set operations are created.
\nWith self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
Status of the stack set's actual configuration compared to its expected template and parameter configuration. A\n stack set is considered to have drifted if one or more of its stack instances have drifted from their expected\n template and parameter configuration.
\n\n DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the\n expected template and parameter configuration. A stack instance is considered to have drifted if one or more of the\n resources in the associated stack have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked the stack set for drift.
\n IN_SYNC: All the stack instances belonging to the stack set stack match from the expected\n template and parameter configuration.
\n UNKNOWN: This value is reserved for future use.
Most recent time when CloudFormation performed a drift detection operation on the stack set. This value\n will be NULL for any stack set on which drift detection hasn't yet been performed.
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structures that contain summary information about the specified stack set.
" + } + }, + "com.amazonaws.cloudformation#StackStatus": { + "type": "enum", + "members": { + "CREATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_IN_PROGRESS" + } + }, + "CREATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FAILED" + } + }, + "CREATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_COMPLETE" + } + }, + "ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_IN_PROGRESS" + } + }, + "ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_FAILED" + } + }, + "ROLLBACK_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK_COMPLETE" + } + }, + "DELETE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_IN_PROGRESS" + } + }, + "DELETE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_FAILED" + } + }, + "DELETE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETE_COMPLETE" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" + } + }, + "UPDATE_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_COMPLETE" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "UPDATE_ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ROLLBACK_IN_PROGRESS" + } + }, + "UPDATE_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ROLLBACK_FAILED" + } + }, + "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" + } + }, + "UPDATE_ROLLBACK_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_ROLLBACK_COMPLETE" + } + }, + "REVIEW_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVIEW_IN_PROGRESS" + } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + }, + "IMPORT_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_COMPLETE" + } + }, + "IMPORT_ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_ROLLBACK_IN_PROGRESS" + } + }, + "IMPORT_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_ROLLBACK_FAILED" + } + }, + "IMPORT_ROLLBACK_COMPLETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_ROLLBACK_COMPLETE" + } + } + } + }, + "com.amazonaws.cloudformation#StackStatusFilter": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackStatus" + } + }, + "com.amazonaws.cloudformation#StackStatusReason": { + "type": "string" + }, + "com.amazonaws.cloudformation#StackSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#StackSummary" + } + }, + "com.amazonaws.cloudformation#StackSummary": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "Unique stack identifier.
" + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name associated with the stack.
", + "smithy.api#required": {} + } + }, + "TemplateDescription": { + "target": "com.amazonaws.cloudformation#TemplateDescription", + "traits": { + "smithy.api#documentation": "The template description of the template used to create the stack.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudformation#CreationTime", + "traits": { + "smithy.api#documentation": "The time the stack was created.
", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.cloudformation#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "The time the stack was last updated. This field will only be returned if the stack has been updated at least\n once.
" + } + }, + "DeletionTime": { + "target": "com.amazonaws.cloudformation#DeletionTime", + "traits": { + "smithy.api#documentation": "The time the stack was deleted.
" + } + }, + "StackStatus": { + "target": "com.amazonaws.cloudformation#StackStatus", + "traits": { + "smithy.api#documentation": "The current status of the stack.
", + "smithy.api#required": {} + } + }, + "StackStatusReason": { + "target": "com.amazonaws.cloudformation#StackStatusReason", + "traits": { + "smithy.api#documentation": "Success/Failure message associated with the stack status.
" + } + }, + "ParentId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this\n stack. For the first level of nested stacks, the root stack is also the parent stack.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + } + }, + "RootId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which\n the nested stack ultimately belongs.
\nFor more information, see Working with Nested Stacks in the\n CloudFormation User Guide.
" + } + }, + "DriftInformation": { + "target": "com.amazonaws.cloudformation#StackDriftInformationSummary", + "traits": { + "smithy.api#documentation": "Summarizes information about whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The StackSummary Data Type
" + } + }, + "com.amazonaws.cloudformation#Stacks": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Stack" + } + }, + "com.amazonaws.cloudformation#StageList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TemplateStage" + } + }, + "com.amazonaws.cloudformation#StaleRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "StaleRequestException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "Another operation has been performed on this stack set since the specified operation was performed.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.cloudformation#StatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.cloudformation#StopStackSetOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#StopStackSetOperationInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#StopStackSetOperationOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the\n unstarted stack instance deployments and wait for those are in-progress to complete.
" + } + }, + "com.amazonaws.cloudformation#StopStackSetOperationInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that you want to stop the operation for.
", + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The ID of the stack operation.
", + "smithy.api#required": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\n\n Required. A string used to identify this tag. You can specify a maximum of 128 characters for a\n tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.
\n Required. A string containing the value for this tag. You can specify a maximum of 256\n characters for a tag value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.
" + } + }, + "com.amazonaws.cloudformation#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudformation#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.cloudformation#Tags": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.cloudformation#TemplateBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudformation#TemplateDescription": { + "type": "string" + }, + "com.amazonaws.cloudformation#TemplateParameter": { + "type": "structure", + "members": { + "ParameterKey": { + "target": "com.amazonaws.cloudformation#ParameterKey", + "traits": { + "smithy.api#documentation": "The name associated with the parameter.
" + } + }, + "DefaultValue": { + "target": "com.amazonaws.cloudformation#ParameterValue", + "traits": { + "smithy.api#documentation": "The default value associated with the parameter.
" + } + }, + "NoEcho": { + "target": "com.amazonaws.cloudformation#NoEcho", + "traits": { + "smithy.api#documentation": "Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "User defined description associated with the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The TemplateParameter data type.
" + } + }, + "com.amazonaws.cloudformation#TemplateParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TemplateParameter" + } + }, + "com.amazonaws.cloudformation#TemplateStage": { + "type": "enum", + "members": { + "Original": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Original" + } + }, + "Processed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Processed" + } + } + } + }, + "com.amazonaws.cloudformation#TemplateSummaryConfig": { + "type": "structure", + "members": { + "TreatUnrecognizedResourceTypesAsWarnings": { + "target": "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings", + "traits": { + "smithy.api#documentation": "If set to True, any unrecognized resource types generate warnings and not an error. Any\n unrecognized resource types are returned in the Warnings output parameter.
Options for the GetTemplateSummary API action.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your\n account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered.\n For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into DescribeType to monitor the current test\n status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The type of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this\n account and Region for testing.
" + } + }, + "LogDeliveryBucket": { + "target": "com.amazonaws.cloudformation#S3Bucket", + "traits": { + "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been\n assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#TestTypeOutput": { + "type": "structure", + "members": { + "TypeVersionArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#ThirdPartyType": { + "type": "enum", + "members": { + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + }, + "MODULE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODULE" + } + }, + "HOOK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOOK" + } + } + } + }, + "com.amazonaws.cloudformation#ThirdPartyTypeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}::type/.+/[0-9a-zA-Z]{12,40}/.+$" + } + }, + "com.amazonaws.cloudformation#TimeoutMinutes": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.cloudformation#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.cloudformation#TokenAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TokenAlreadyExistsException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "A client request token already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudformation#TotalStackInstancesCount": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.cloudformation#TransformName": { + "type": "string" + }, + "com.amazonaws.cloudformation#TransformsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TransformName" + } + }, + "com.amazonaws.cloudformation#TreatUnrecognizedResourceTypesAsWarnings": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#Type": { + "type": "string" + }, + "com.amazonaws.cloudformation#TypeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type/.+$" + } + }, + "com.amazonaws.cloudformation#TypeConfiguration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 204800 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,256}$" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:([0-9]{12})?:type-configuration/.+$" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.cloudformation#TypeConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
" + } + }, + "Alias": { + "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", + "traits": { + "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was set.
" + } + }, + "Configuration": { + "target": "com.amazonaws.cloudformation#TypeConfiguration", + "traits": { + "smithy.api#documentation": "A JSON string specifying the configuration data for the extension, in this account and Region.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n {}.
When the configuration data was last updated for this extension.
\nIf a configuration hasn't been set for a specified extension, CloudFormation returns\n null.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The name of the extension.
" + } + }, + "IsDefaultConfiguration": { + "target": "com.amazonaws.cloudformation#IsDefaultConfiguration", + "traits": { + "smithy.api#documentation": "Whether this configuration data is the default configuration for the extension.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information concerning the specification of a CloudFormation extension in a given account and\n Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationDetailsList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeConfigurationDetails" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationIdentifier": { + "type": "structure", + "members": { + "TypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
" + } + }, + "TypeConfigurationAlias": { + "target": "com.amazonaws.cloudformation#TypeConfigurationAlias", + "traits": { + "smithy.api#documentation": "The alias specified for this configuration, if one was specified when the configuration was set.
" + } + }, + "TypeConfigurationArn": { + "target": "com.amazonaws.cloudformation#TypeConfigurationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the configuration, in this account and Region.
" + } + }, + "Type": { + "target": "com.amazonaws.cloudformation#ThirdPartyType", + "traits": { + "smithy.api#documentation": "The type of extension.
" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The name of the extension type to which this configuration applies.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Identifying information for the configuration of a CloudFormation extension.
" + } + }, + "com.amazonaws.cloudformation#TypeConfigurationIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.cloudformation#TypeConfigurationNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "An message with details about the error that occurred.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TypeConfigurationNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified extension configuration can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudformation#TypeFilters": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.cloudformation#Category", + "traits": { + "smithy.api#documentation": "The category of extensions to return.
\n\n REGISTERED: Private extensions that have been registered for this account and Region.
\n ACTIVATED: Public extensions that have been activated for this account and Region.
\n THIRD_PARTY: Extensions available for use from publishers other than Amazon. This\n includes:
Private extensions registered in the account.
\nPublic extensions from publishers other than Amazon, whether activated or not.
\n\n AWS_TYPES: Extensions available for use from Amazon.
The id of the publisher of the extension.
\nExtensions published by Amazon aren't assigned a publisher ID. Use the AWS_TYPES category to\n specify a list of types published by Amazon.
A prefix to use as a filter for results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Filter criteria to use in determining which extensions to return.
" + } + }, + "com.amazonaws.cloudformation#TypeHierarchy": { + "type": "string" + }, + "com.amazonaws.cloudformation#TypeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 204 + }, + "smithy.api#pattern": "^[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}(::MODULE){0,1}$" + } + }, + "com.amazonaws.cloudformation#TypeNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 204 + }, + "smithy.api#pattern": "^([A-Za-z0-9]{2,64}::){0,2}([A-Za-z0-9]{2,64}:?){0,1}$" + } + }, + "com.amazonaws.cloudformation#TypeNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudformation#ErrorMessage", + "traits": { + "smithy.api#documentation": "An message with details about the error that occurred.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TypeNotFoundException", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified extension doesn't exist in the CloudFormation registry.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudformation#TypeSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16777216 + } + } + }, + "com.amazonaws.cloudformation#TypeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeSummary" + } + }, + "com.amazonaws.cloudformation#TypeSummary": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", + "traits": { + "smithy.api#documentation": "The kind of extension.
" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The name of the extension.
\nIf you specified a TypeNameAlias when you activate this extension in your account\n and Region, CloudFormation considers that alias as the type name.
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more\n information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" + } + }, + "TypeArn": { + "target": "com.amazonaws.cloudformation#TypeArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
" + } + }, + "LastUpdated": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nFor all other extension types, CloudFormation returns null.
The description of the extension.
" + } + }, + "PublisherId": { + "target": "com.amazonaws.cloudformation#PublisherId", + "traits": { + "smithy.api#documentation": "The ID of the extension publisher, if the extension is published by a third party. Extensions published by\n Amazon don't return a publisher ID.
" + } + }, + "OriginalTypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region.
\nHow you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the latest version of the public\n extension that is available. For any extensions other than activated third-arty extensions,\n CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
The service used to verify the publisher identity.
\nFor more information, see Registering your account to publish CloudFormation extensions in the CFN-CLI User Guide for Extension\n Development.
" + } + }, + "PublisherName": { + "target": "com.amazonaws.cloudformation#PublisherName", + "traits": { + "smithy.api#documentation": "The publisher name, as defined in the public profile for that publisher in the service used to verify the\n publisher identity.
" + } + }, + "IsActivated": { + "target": "com.amazonaws.cloudformation#IsActivated", + "traits": { + "smithy.api#documentation": "Whether the extension is activated for this account and Region.
\nThis applies only to third-party public extensions. Extensions published by Amazon are activated by\n default.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains summary information about the specified CloudFormation extension.
" + } + }, + "com.amazonaws.cloudformation#TypeTestsStatus": { + "type": "enum", + "members": { + "PASSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "NOT_TESTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_TESTED" + } + } + } + }, + "com.amazonaws.cloudformation#TypeTestsStatusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\s\\S]+$" + } + }, + "com.amazonaws.cloudformation#TypeVersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]+$" + } + }, + "com.amazonaws.cloudformation#TypeVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeVersionSummary" + } + }, + "com.amazonaws.cloudformation#TypeVersionSummary": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.cloudformation#RegistryType", + "traits": { + "smithy.api#documentation": "The kind of extension.
" + } + }, + "TypeName": { + "target": "com.amazonaws.cloudformation#TypeName", + "traits": { + "smithy.api#documentation": "The name of the extension.
" + } + }, + "VersionId": { + "target": "com.amazonaws.cloudformation#TypeVersionId", + "traits": { + "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it's registered.
" + } + }, + "IsDefaultVersion": { + "target": "com.amazonaws.cloudformation#IsDefaultVersion", + "traits": { + "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon.\n For public third-party extensions, CloudFormation returns null.
The Amazon Resource Name (ARN) of the extension version.
" + } + }, + "TimeCreated": { + "target": "com.amazonaws.cloudformation#Timestamp", + "traits": { + "smithy.api#documentation": "When the version was registered.
" + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "The description of the extension version.
" + } + }, + "PublicVersionNumber": { + "target": "com.amazonaws.cloudformation#PublicVersionNumber", + "traits": { + "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the version of the public extension\n to be used for CloudFormation operations in this account and Region. For any extensions other than activated\n third-arty extensions, CloudFormation returns null.
How you specified AutoUpdate when enabling the extension affects whether CloudFormation\n automatically updates the extension in this account and Region when a new version is released. For more information,\n see Setting CloudFormation to automatically use new versions of extensions in the\n CloudFormation User Guide.
Contains summary information about a specific version of a CloudFormation extension.
" + } + }, + "com.amazonaws.cloudformation#UnprocessedTypeConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudformation#TypeConfigurationIdentifier" + } + }, + "com.amazonaws.cloudformation#UpdateStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#UpdateStackInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#UpdateStackOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InsufficientCapabilitiesException" + }, + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack through the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate\n action.
\nFor more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.
" + } + }, + "com.amazonaws.cloudformation#UpdateStackInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackName", + "traits": { + "smithy.api#documentation": "The name or unique stack ID of the stack to update.
", + "smithy.api#required": {} + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + } + }, + "StackPolicyDuringUpdateURL": { + "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", + "traits": { + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" + } + }, + "Parameters": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which\n are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros to Perform Custom\n Processing on Templates.
\nThe template resource types that you have permissions to work with for this update stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
" + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" + } + }, + "RollbackConfiguration": { + "target": "com.amazonaws.cloudformation#RollbackConfiguration", + "traits": { + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" + } + }, + "StackPolicyBody": { + "target": "com.amazonaws.cloudformation#StackPolicyBody", + "traits": { + "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + } + }, + "StackPolicyURL": { + "target": "com.amazonaws.cloudformation#StackPolicyURL", + "traits": { + "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" + } + }, + "NotificationARNs": { + "target": "com.amazonaws.cloudformation#NotificationARNs", + "traits": { + "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates\n with the stack. Specify an empty list to remove all notification topics.
" + } + }, + "Tags": { + "target": "com.amazonaws.cloudformation#Tags", + "traits": { + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported\n resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an\n empty value, CloudFormation removes all associated tags.
" + } + }, + "DisableRollback": { + "target": "com.amazonaws.cloudformation#DisableRollback", + "traits": { + "smithy.api#documentation": "Preserve the state of previously provisioned resources when an operation fails.
\nDefault: False\n
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
When set to true, newly created resources are deleted when the operation rolls back. This includes newly\n created resources marked with a deletion policy of Retain.
Default: false\n
The input for an UpdateStack action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#UpdateStackInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#UpdateStackInstancesInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#UpdateStackInstancesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#OperationInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StaleRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
\nYou can only update stack instances in Amazon Web Services Regions and accounts where they already exist; to\n create additional stack instances, use CreateStackInstances.
\nDuring stack set updates, any parameters overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only update the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set\n template. If you add a parameter to a template, before you can override the parameter value specified in the stack\n set you must first use UpdateStackSet to update all stack\n instances with the updated template and parameter value specified in the stack set. Once a stack instance has been\n updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
The name or unique ID of the stack set associated with the stack instances.
", + "smithy.api#required": {} + } + }, + "Accounts": { + "target": "com.amazonaws.cloudformation#AccountList", + "traits": { + "smithy.api#documentation": "[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update\n parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the\n specified accounts and Amazon Web Services Regions.
\nYou can specify Accounts or DeploymentTargets, but not both.
[Service-managed permissions] The Organizations accounts for which you want to update parameter values\n for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are\n currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future\n won't use the overridden values.
\nYou can specify Accounts or DeploymentTargets, but not both.
The names of one or more Amazon Web Services Regions in which you want to update parameter values for stack\n instances. The overridden parameter values will be applied to all stack instances in the specified accounts and\n Amazon Web Services Regions.
", + "smithy.api#required": {} + } + }, + "ParameterOverrides": { + "target": "com.amazonaws.cloudformation#Parameters", + "traits": { + "smithy.api#documentation": "A list of input parameters whose values you want to update for the specified stack instances.
\nAny overridden parameter values will be applied to all stack instances in the specified accounts and Amazon Web Services Regions. When specifying parameters and their values, be aware of how CloudFormation sets\n parameter values during stack instance update operations:
\nTo override the current value for a parameter, include the parameter and specify its value.
\nTo leave an overridden parameter set to its present value, include the parameter and specify\n UsePreviousValue as true. (You can't specify both a value and set\n UsePreviousValue to true.)
To set an overridden parameter back to the value specified in the stack set, specify a parameter list but\n don't include the parameter in the list.
\nTo leave all parameters set to their present values, don't specify this property at all.
\nDuring stack set updates, any parameter values overridden for a stack instance aren't updated, but retain their\n overridden value.
\nYou can only override the parameter values that are specified in the stack set; to add or\n delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter\n to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to\n update all stack instances with the updated template and parameter value specified in the stack set. Once a stack\n instance has been updated with the new parameter, you can then override the parameter value using\n UpdateStackInstances.
Preferences for how CloudFormation performs this stack set operation.
" + } + }, + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique identifier for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, the SDK generates one automatically.
", + "smithy.api#idempotencyToken": {} + } + }, + "CallAs": { + "target": "com.amazonaws.cloudformation#CallAs", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nThe unique identifier for this stack set operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#UpdateStackOutput": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "Unique identifier of the stack.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for an UpdateStack action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#UpdateStackSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#UpdateStackSetInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#UpdateStackSetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#InvalidOperationException" + }, + { + "target": "com.amazonaws.cloudformation#OperationIdAlreadyExistsException" + }, + { + "target": "com.amazonaws.cloudformation#OperationInProgressException" + }, + { + "target": "com.amazonaws.cloudformation#StackInstanceNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StackSetNotFoundException" + }, + { + "target": "com.amazonaws.cloudformation#StaleRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.
\nEven if the stack set operation created by updating the stack set fails (completely or partially, below or above\n a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.
" + } + }, + "com.amazonaws.cloudformation#UpdateStackSetInput": { + "type": "structure", + "members": { + "StackSetName": { + "target": "com.amazonaws.cloudformation#StackSetName", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack set that you want to update.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.cloudformation#Description", + "traits": { + "smithy.api#documentation": "A brief description of updates that you are making.
" + } + }, + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200\n bytes. For more information, see Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
The location of the file that contains the template body. The URL must point to a template (maximum size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,\n see Template\n Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
Use the existing template that's associated with the stack set that you're updating.
\nConditional: You must specify only one of the following parameters: TemplateBody or\n TemplateURL—or set UsePreviousTemplate to true.
A list of input parameters for the stack set template.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack set and its associated stack instances.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks sets, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some templates reference macros. If your stack set template references one or more macros, you must update the\n stack set directly from the processed template, without first reviewing the resulting changes in a change set. To\n update the stack set directly, you must acknowledge this capability. For more information, see Using CloudFormation Macros to Perform\n Custom Processing on Templates.
\nStack sets with service-managed permissions do not currently support the use of macros in templates. (This\n includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.) Even if you specify this capability for a\n stack set with service-managed permissions, if you reference a macro in your template the stack set operation will\n fail.
\nThe key-value pairs to associate with this stack set and the stacks created from it. CloudFormation also\n propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50\n tags.
\nIf you specify tags for this parameter, those tags replace any list of tags that are currently associated with\n this stack set. This means:
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags.
\nIf you specify any tags using this parameter, you must specify all\n the tags that you want associated with this stack set, even tags you've specified before (for example, when\n creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the\n updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.
\nIf you specify an empty value, CloudFormation removes all currently associated tags.
\nIf you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if\n you have the required IAM permission to tag resources. If you omit tags that are currently associated\n with the stack set from the list of tags you specify, CloudFormation assumes that you want to remove those tags\n from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary\n permission(s), the entire UpdateStackSet action fails with an access denied error, and the\n stack set is not updated.
Preferences for how CloudFormation performs this stack set operation.
" + } + }, + "AdministrationRoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to use to update this stack set.
\nSpecify an IAM role only if you are using customized administrator roles to control which users\n or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set\n Operations in the CloudFormation User Guide.
\nIf you specified a customized administrator role when you created the stack set, you must specify a customized\n administrator role, even if it is the same customized administrator role used with this stack set previously.
" + } + }, + "ExecutionRoleName": { + "target": "com.amazonaws.cloudformation#ExecutionRoleName", + "traits": { + "smithy.api#documentation": "The name of the IAM execution role to use to update the stack set. If you do not specify an\n execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set\n operation.
Specify an IAM role only if you are using customized execution roles to control which stack\n resources users and groups can include in their stack sets.
\nIf you specify a customized execution role, CloudFormation uses that role to update the stack. If you do not specify a\n customized execution role, CloudFormation performs the update using the role previously associated with the stack set, so long\n as you have permissions to perform operations on the stack set.
" + } + }, + "DeploymentTargets": { + "target": "com.amazonaws.cloudformation#DeploymentTargets", + "traits": { + "smithy.api#documentation": "[Service-managed permissions] The Organizations accounts in which to update associated stack\n instances.
\nTo update all the stack instances associated with this stack set, do not specify DeploymentTargets\n or Regions.
If the stack set update includes changes to the template (that is, if TemplateBody or\n TemplateURL is specified), or the Parameters, CloudFormation marks all stack instances\n with a status of OUTDATED prior to updating the stack instances in the specified accounts and Amazon Web Services Regions. If the stack set update doesn't include changes to the template or parameters, CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with\n their existing stack instance status.
Describes how the IAM roles required for stack set operations are created. You cannot modify\n PermissionModel if there are stack instances associated with your stack set.
With self-managed permissions, you must create the administrator and execution roles required to\n deploy to target accounts. For more information, see Grant Self-Managed Stack Set\n Permissions.
With service-managed permissions, StackSets automatically creates the IAM roles\n required to deploy to accounts managed by Organizations. For more information, see Grant\n Service-Managed Stack Set Permissions.
[Service-managed permissions] Describes whether StackSets automatically deploys to Organizations\n accounts that are added to a target organization or organizational unit (OU).
\nIf you specify AutoDeployment, don't specify DeploymentTargets or\n Regions.
The unique ID for this stack set operation.
\nThe operation ID also functions as an idempotency token, to ensure that CloudFormation performs the\n stack set operation only once, even if you retry the request multiple times. You might retry stack set operation\n requests to ensure that CloudFormation successfully received them.
\nIf you don't specify an operation ID, CloudFormation generates one automatically.
\nRepeating this stack set operation with a new operation ID retries all stack instances whose status is\n OUTDATED.
[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts,\n you must also specify the Amazon Web Services Regions in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, don't specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Amazon Web Services Regions. If the stack set update does not include changes to the template or parameters, CloudFormation\n updates the stack instances in the specified accounts and Amazon Web Services Regions, while leaving all other stack\n instances with their existing stack instance status.
The Amazon Web Services Regions in which to update associated stack instances. If you specify Regions, you must\n also specify accounts in which to update stack set instances.
\nTo update all the stack instances associated with this stack set, do not specify the\n Accounts or Regions properties.
If the stack set update includes changes to the template (that is, if the TemplateBody or\n TemplateURL properties are specified), or the Parameters property, CloudFormation marks all stack\n instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and\n Regions. If the stack set update does not include changes to the template or parameters, CloudFormation updates the stack\n instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack\n instance status.
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting\n operations.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#UpdateStackSetOutput": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The unique ID for this stack set operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#UpdateTerminationProtection": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput" + }, + "traits": { + "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + } + }, + "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { + "type": "structure", + "members": { + "EnableTerminationProtection": { + "target": "com.amazonaws.cloudformation#EnableTerminationProtection", + "traits": { + "smithy.api#documentation": "Whether to enable termination protection on the specified stack.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "The name or unique ID of the stack for which you want to set termination protection.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "The unique ID of the stack.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#Url": { + "type": "string" + }, + "com.amazonaws.cloudformation#UsePreviousTemplate": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#UsePreviousValue": { + "type": "boolean" + }, + "com.amazonaws.cloudformation#ValidateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#ValidateTemplateInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" + }, + "traits": { + "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't,\n CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation\n returns a template validation error.
" + } + }, + "com.amazonaws.cloudformation#ValidateTemplateInput": { + "type": "structure", + "members": { + "TemplateBody": { + "target": "com.amazonaws.cloudformation#TemplateBody", + "traits": { + "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
The input for ValidateTemplate action.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudformation#ValidateTemplateOutput": { + "type": "structure", + "members": { + "Parameters": { + "target": "com.amazonaws.cloudformation#TemplateParameters", + "traits": { + "smithy.api#documentation": "A list of TemplateParameter structures.
The description found within the template.
" + } + }, + "Capabilities": { + "target": "com.amazonaws.cloudformation#Capabilities", + "traits": { + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return\n an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" + } + }, + "CapabilitiesReason": { + "target": "com.amazonaws.cloudformation#CapabilitiesReason", + "traits": { + "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response element.
A list of the transforms that are declared in the template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output for ValidateTemplate action.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.cloudformation#Value": { + "type": "string" + }, + "com.amazonaws.cloudformation#Version": { + "type": "string" + }, + "com.amazonaws.cloudformation#VersionBump": { + "type": "enum", + "members": { + "MAJOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAJOR" + } + }, + "MINOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINOR" + } + } + } + }, + "com.amazonaws.cloudformation#Visibility": { + "type": "enum", + "members": { + "PUBLIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLIC" + } + }, + "PRIVATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATE" + } + } + } + }, + "com.amazonaws.cloudformation#Warnings": { + "type": "structure", + "members": { + "UnrecognizedResourceTypes": { + "target": "com.amazonaws.cloudformation#ResourceTypes", + "traits": { + "smithy.api#documentation": "A list of all of the unrecognized resource types. This is only returned if the\n TemplateSummaryConfig parameter has the TreatUnrecognizedResourceTypesAsWarning\n configuration set to True.
Contains any warnings returned by the GetTemplateSummary API action.
Contains any warnings returned by the GetTemplateSummary API action.
Welcome to the AWS Entity Resolution API Reference.
\nAWS Entity Resolution is an AWS service that provides pre-configured entity resolution capabilities \n that enable developers and analysts at advertising and marketing companies to build an accurate and \n complete view of their consumers.
\n\n With AWS Entity Resolution, you have the ability to match source records containing consumer identifiers, \n such as name, email address, and phone number. This holds true even when these records have incomplete or \n conflicting identifiers. For example, AWS Entity Resolution can effectively match a source record from a \n customer relationship management (CRM) system, which includes account information like first name, last name, \n postal address, phone number, and email address, with a source record from a marketing system containing \n campaign information, such as username and email address.
\nTo learn more about AWS Entity Resolution concepts, procedures, and best practices, see the\n AWS Entity Resolution \n User Guide.
", - "smithy.api#title": "AWS EntityResolution", - "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" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "smithy": "2.0", + "shapes": { + "com.amazonaws.entityresolution#AWSVeniceService": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.entityresolution#CreateMatchingWorkflow" }, { - "conditions": [], - "type": "tree", - "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" - } - ] - } - ] - }, - { - "conditions": [], - "type": "tree", - "rules": [ + "target": "com.amazonaws.entityresolution#CreateSchemaMapping" + }, { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "target": "com.amazonaws.entityresolution#DeleteMatchingWorkflow" + }, + { + "target": "com.amazonaws.entityresolution#DeleteSchemaMapping" + }, + { + "target": "com.amazonaws.entityresolution#GetMatchId" + }, + { + "target": "com.amazonaws.entityresolution#GetMatchingJob" + }, + { + "target": "com.amazonaws.entityresolution#GetMatchingWorkflow" + }, + { + "target": "com.amazonaws.entityresolution#GetSchemaMapping" + }, + { + "target": "com.amazonaws.entityresolution#ListMatchingJobs" + }, + { + "target": "com.amazonaws.entityresolution#ListMatchingWorkflows" + }, + { + "target": "com.amazonaws.entityresolution#ListSchemaMappings" + }, + { + "target": "com.amazonaws.entityresolution#ListTagsForResource" + }, + { + "target": "com.amazonaws.entityresolution#StartMatchingJob" + }, + { + "target": "com.amazonaws.entityresolution#TagResource" + }, + { + "target": "com.amazonaws.entityresolution#UntagResource" + }, + { + "target": "com.amazonaws.entityresolution#UpdateMatchingWorkflow" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EntityResolution", + "arnNamespace": "entityresolution", + "cloudTrailEventSource": "entityresolution.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "entityresolution" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "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-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "Welcome to the Entity Resolution API Reference.
\nEntity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities \n that enable developers and analysts at advertising and marketing companies to build an accurate and \n complete view of their consumers.
\n\n With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address, \n and phone number. This is true even when these records have incomplete or conflicting identifiers. For example, \n Entity Resolution can effectively match a source record from a customer relationship management (CRM) system \n with a source record from a marketing system containing campaign information.
\nTo learn more about Entity Resolution concepts, procedures, and best practices, see the\n Entity Resolution \n User Guide.
", + "smithy.api#title": "AWS EntityResolution", + "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" } - ], - "type": "tree", - "rules": [ + }, + "rules": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ + "conditions": [ { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [ { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ + "conditions": [], + "type": "tree", + "rules": [ { - "ref": "PartitionResult" + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, - "supportsDualStack" - ] - } - ] + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } - ], - "type": "tree", - "rules": [ + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://entityresolution.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://entityresolution-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-east-1.api.aws" } - ] }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution.us-east-1.api.aws" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://entityresolution-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "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://entityresolution.us-east-1.amazonaws.com" } - ] }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false } - ] }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://entityresolution-fips.cn-north-1.amazonaws.com.cn" } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://entityresolution.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + }, + "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://entityresolution.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://entityresolution.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://entityresolution-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://entityresolution-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://entityresolution.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://entityresolution.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://entityresolution-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://entityresolution.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://entityresolution-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://entityresolution.us-isob-east-1.sc2s.sgov.gov" } - ] }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" + "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" } - ] }, { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://entityresolution.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" } - ] } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://entityresolution-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://entityresolution-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://entityresolution.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://entityresolution.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://entityresolution-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://entityresolution-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://entityresolution.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://entityresolution.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://entityresolution-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://entityresolution-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://entityresolution.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://entityresolution.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://entityresolution-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://entityresolution.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://entityresolution-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://entityresolution.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.entityresolution#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.entityresolution#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "You do not have sufficient access to perform this action. HTTP Status Code: 403\n
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, \n Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400\n
Creates a MatchingWorkflow object which stores the configuration of the data processing job \n to be run. It is important to note that there should not be a pre-existing MatchingWorkflow \n with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
The name of the workflow. There cannot be multiple DataIntegrationWorkflows with the same name.
A description of the workflow.
" - } - }, - "inputSourceConfig": { - "target": "com.amazonaws.entityresolution#InputSourceConfig", - "traits": { - "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.entityresolution#TagMap", - "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#CreateMatchingWorkflowOutput": { - "type": "structure", - "members": { - "workflowName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the workflow.
", - "smithy.api#required": {} - } - }, - "workflowArn": { - "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", - "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
" - } - }, - "inputSourceConfig": { - "target": "com.amazonaws.entityresolution#InputSourceConfig", - "traits": { - "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#CreateSchemaMapping": { - "type": "operation", - "input": { - "target": "com.amazonaws.entityresolution#CreateSchemaMappingInput" - }, - "output": { - "target": "com.amazonaws.entityresolution#CreateSchemaMappingOutput" - }, - "errors": [ - { - "target": "com.amazonaws.entityresolution#AccessDeniedException" - }, - { - "target": "com.amazonaws.entityresolution#ConflictException" - }, - { - "target": "com.amazonaws.entityresolution#ExceedsLimitException" - }, - { - "target": "com.amazonaws.entityresolution#InternalServerException" - }, - { - "target": "com.amazonaws.entityresolution#ThrottlingException" - }, - { - "target": "com.amazonaws.entityresolution#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a schema mapping, which defines the schema of the input customer records table.\n The SchemaMapping also provides Entity Resolution with some metadata about the\n table, such as the attribute types of the columns and which columns to match on.
The name of the schema. There cannot be multiple SchemaMappings with the\n same name.
A description of the schema.
" - } - }, - "mappedInputFields": { - "target": "com.amazonaws.entityresolution#SchemaInputAttributes", - "traits": { - "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
The tags used to organize, track, or control access for this resource.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#CreateSchemaMappingOutput": { - "type": "structure", - "members": { - "schemaName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the schema.
", - "smithy.api#required": {} - } - }, - "schemaArn": { - "target": "com.amazonaws.entityresolution#SchemaMappingArn", - "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the\n SchemaMapping.
A description of the schema.
", - "smithy.api#required": {} - } - }, - "mappedInputFields": { - "target": "com.amazonaws.entityresolution#SchemaInputAttributes", - "traits": { - "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a \n workflow with the given name does not exist.
The name of the workflow to be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#DeleteMatchingWorkflowOutput": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "A successful operation message.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#DeleteSchemaMapping": { - "type": "operation", - "input": { - "target": "com.amazonaws.entityresolution#DeleteSchemaMappingInput" - }, - "output": { - "target": "com.amazonaws.entityresolution#DeleteSchemaMappingOutput" - }, - "errors": [ - { - "target": "com.amazonaws.entityresolution#AccessDeniedException" - }, - { - "target": "com.amazonaws.entityresolution#ConflictException" - }, - { - "target": "com.amazonaws.entityresolution#InternalServerException" - }, - { - "target": "com.amazonaws.entityresolution#ThrottlingException" - }, - { - "target": "com.amazonaws.entityresolution#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the SchemaMapping with a given name. This operation will succeed even if a schema \n with the given name does not exist. This operation will fail if there is a DataIntegrationWorkflow \n object that references the SchemaMapping in the workflow's InputSourceConfig.
The name of the schema to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#DeleteSchemaMappingOutput": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "A successful operation message.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 255 - } - } - }, - "com.amazonaws.entityresolution#EntityName": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z_0-9-]*$" - } - }, - "com.amazonaws.entityresolution#ErrorDetails": { - "type": "structure", - "members": { - "errorMessage": { - "target": "com.amazonaws.entityresolution#ErrorMessage", - "traits": { - "smithy.api#documentation": "The error message from the job, if there is one.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object containing an error message, if there was an error.
" - } - }, - "com.amazonaws.entityresolution#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.entityresolution#ExceedsLimitException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.entityresolution#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits. \n The error message describes the limit exceeded. HTTP Status Code: 402\n
Returns the corresponding Match ID of a customer record if the record has been processed.
", - "smithy.api#http": { - "code": 200, - "method": "POST", - "uri": "/matchingworkflows/{workflowName}/matches" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.entityresolution#GetMatchIdInput": { - "type": "structure", - "members": { - "workflowName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the workflow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "record": { - "target": "com.amazonaws.entityresolution#RecordAttributeMap", - "traits": { - "smithy.api#documentation": "The record to fetch the Match ID for.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#GetMatchIdOutput": { - "type": "structure", - "members": { - "matchId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "The unique identifiers for this group of match records.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#GetMatchingJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.entityresolution#GetMatchingJobInput" - }, - "output": { - "target": "com.amazonaws.entityresolution#GetMatchingJobOutput" - }, - "errors": [ - { - "target": "com.amazonaws.entityresolution#AccessDeniedException" - }, - { - "target": "com.amazonaws.entityresolution#InternalServerException" - }, - { - "target": "com.amazonaws.entityresolution#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.entityresolution#ThrottlingException" - }, - { - "target": "com.amazonaws.entityresolution#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets the status, metrics, and errors (if there are any) that are associated with a job.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/matchingworkflows/{workflowName}/jobs/{jobId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.entityresolution#GetMatchingJobInput": { - "type": "structure", - "members": { - "workflowName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the workflow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "jobId": { - "target": "com.amazonaws.entityresolution#JobId", - "traits": { - "smithy.api#documentation": "The ID of the job.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#GetMatchingJobOutput": { - "type": "structure", - "members": { - "jobId": { - "target": "com.amazonaws.entityresolution#JobId", - "traits": { - "smithy.api#documentation": "The ID of the job.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.entityresolution#JobStatus", - "traits": { - "smithy.api#documentation": "The current status of the job. Either running, succeeded, \n queued, or failed.
The time at which the job was started.
", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the job has finished.
" - } - }, - "metrics": { - "target": "com.amazonaws.entityresolution#JobMetrics", - "traits": { - "smithy.api#documentation": "Metrics associated with the execution, specifically total records processed, \n unique IDs generated, and records the execution skipped.
" - } - }, - "errorDetails": { - "target": "com.amazonaws.entityresolution#ErrorDetails", - "traits": { - "smithy.api#documentation": "An object containing an error message, if there was an error.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#GetMatchingWorkflow": { - "type": "operation", - "input": { - "target": "com.amazonaws.entityresolution#GetMatchingWorkflowInput" - }, - "output": { - "target": "com.amazonaws.entityresolution#GetMatchingWorkflowOutput" - }, - "errors": [ - { - "target": "com.amazonaws.entityresolution#AccessDeniedException" - }, - { - "target": "com.amazonaws.entityresolution#InternalServerException" - }, - { - "target": "com.amazonaws.entityresolution#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.entityresolution#ThrottlingException" - }, - { - "target": "com.amazonaws.entityresolution#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the MatchingWorkflow with a given name, if it exists.
The name of the workflow.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#GetMatchingWorkflowOutput": { - "type": "structure", - "members": { - "workflowName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the workflow.
", - "smithy.api#required": {} - } - }, - "workflowArn": { - "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", - "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
" - } - }, - "inputSourceConfig": { - "target": "com.amazonaws.entityresolution#InputSourceConfig", - "traits": { - "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
The timestamp of when the workflow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the workflow was last updated.
", - "smithy.api#required": {} - } - }, - "incrementalRunConfig": { - "target": "com.amazonaws.entityresolution#IncrementalRunConfig", - "traits": { - "smithy.api#documentation": "An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access \n resources on your behalf.
", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.entityresolution#TagMap", - "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#GetSchemaMapping": { - "type": "operation", - "input": { - "target": "com.amazonaws.entityresolution#GetSchemaMappingInput" - }, - "output": { - "target": "com.amazonaws.entityresolution#GetSchemaMappingOutput" - }, - "errors": [ - { - "target": "com.amazonaws.entityresolution#AccessDeniedException" - }, - { - "target": "com.amazonaws.entityresolution#InternalServerException" - }, - { - "target": "com.amazonaws.entityresolution#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.entityresolution#ThrottlingException" - }, - { - "target": "com.amazonaws.entityresolution#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Returns the SchemaMapping of a given name.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/schemas/{schemaName}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.entityresolution#GetSchemaMappingInput": { - "type": "structure", - "members": { - "schemaName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the schema to be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#GetSchemaMappingOutput": { - "type": "structure", - "members": { - "schemaName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the schema.
", - "smithy.api#required": {} - } - }, - "schemaArn": { - "target": "com.amazonaws.entityresolution#SchemaMappingArn", - "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.entityresolution#Description", - "traits": { - "smithy.api#documentation": "A description of the schema.
" - } - }, - "mappedInputFields": { - "target": "com.amazonaws.entityresolution#SchemaInputAttributes", - "traits": { - "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n Venice uses for matching.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
The tags used to organize, track, or control access for this resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#IncrementalRunConfig": { - "type": "structure", - "members": { - "incrementalRunType": { - "target": "com.amazonaws.entityresolution#IncrementalRunType", - "traits": { - "smithy.api#documentation": "The type of incremental run. It takes only one value: IMMEDIATE.
An object which defines an incremental run type and has only incrementalRunType as a field.
An Glue table ARN for the input source table.
", - "smithy.api#pattern": "^arn:aws:.*:.*:[0-9]+:.*$", - "smithy.api#required": {} - } - }, - "schemaName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the schema to be retrieved.
", - "smithy.api#required": {} - } - }, - "applyNormalization": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "Normalizes the attributes defined in the schema in the input data. For example, if an\n attribute has an AttributeType of PHONE_NUMBER, and the data in\n the input table is in a format of 1234567890, Entity Resolution will normalize this field\n in the output to (123)-456-7890.
An object containing InputSourceARN, SchemaName, \n and ApplyNormalization.
This exception occurs when there is an internal failure in the AWS Entity Resolution service. HTTP Status Code: 500\n
The total number of input records.
" - } - }, - "totalRecordsProcessed": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The total number of records processed.
" - } - }, - "matchIDs": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "The total number of matchIDs generated.
The total number of records that did not get processed,
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object containing InputRecords, TotalRecordsProcessed, \n MatchIDs, and RecordsNotProcessed.
The ID of the job.
", - "smithy.api#required": {} - } - }, - "status": { - "target": "com.amazonaws.entityresolution#JobStatus", - "traits": { - "smithy.api#documentation": "The current status of the job. Either running, succeeded, \n queued, or failed.
The time at which the job was started.
", - "smithy.api#required": {} - } - }, - "endTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the job has finished.
" - } - } - }, - "traits": { - "smithy.api#documentation": "An object containing the JobId, Status, \n StartTime, and EndTime of a job.
Lists all jobs for a given workflow.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/matchingworkflows/{workflowName}/jobs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "jobs" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.entityresolution#ListMatchingJobsInput": { - "type": "structure", - "members": { - "workflowName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the workflow to be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.entityresolution#NextToken", - "traits": { - "smithy.api#documentation": "The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "min": 1, - "max": 25 - } - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#ListMatchingJobsOutput": { - "type": "structure", - "members": { - "jobs": { - "target": "com.amazonaws.entityresolution#JobList", - "traits": { - "smithy.api#documentation": "A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
" - } - }, - "nextToken": { - "target": "com.amazonaws.entityresolution#NextToken", - "traits": { - "smithy.api#documentation": "The pagination token from the previous ListSchemaMappings API call.
Returns a list of all the MatchingWorkflows that have been created for an AWS account.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "max": 25 - } - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#ListMatchingWorkflowsOutput": { - "type": "structure", - "members": { - "workflowSummaries": { - "target": "com.amazonaws.entityresolution#MatchingWorkflowList", - "traits": { - "smithy.api#documentation": "A list of MatchingWorkflowSummary objects, each of which contain the fields \n WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The pagination token from the previous ListSchemaMappings API call.
Returns a list of all the SchemaMappings that have been created for an AWS account.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "max": 25 - } - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#ListSchemaMappingsOutput": { - "type": "structure", - "members": { - "schemaList": { - "target": "com.amazonaws.entityresolution#SchemaMappingList", - "traits": { - "smithy.api#documentation": "A list of SchemaMappingSummary objects, each of which contain the fields \n SchemaName, SchemaArn, CreatedAt, UpdatedAt.
The pagination token from the previous ListDomains API call.
Displays the tags associated with an AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
The ARN of the resource for which you want to view tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.entityresolution#TagMap", - "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#MatchingKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.entityresolution#AttributeName" - } - }, - "com.amazonaws.entityresolution#MatchingWorkflowArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$" - } - }, - "com.amazonaws.entityresolution#MatchingWorkflowList": { - "type": "list", - "member": { - "target": "com.amazonaws.entityresolution#MatchingWorkflowSummary" - } - }, - "com.amazonaws.entityresolution#MatchingWorkflowSummary": { - "type": "structure", - "members": { - "workflowName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the workflow.
", - "smithy.api#required": {} - } - }, - "workflowArn": { - "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", - "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The timestamp of when the workflow was created.
", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of when the workflow was last updated.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A list of MatchingWorkflowSummary objects, each of which contain the fields \n WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.
A name of a column to be written to the output. This must be an InputField name \n in the schema mapping.
Enables the ability to hash the column values in the output.
" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
The S3 path to which Entity Resolution will write the output table.
", - "smithy.api#pattern": "^s3://([^/]+)/?(.*?([^/]+)/?)$", - "smithy.api#required": {} - } - }, - "output": { - "target": "com.amazonaws.entityresolution#OutputAttributes", - "traits": { - "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
Customer KMS ARN for encryption at rest. If not provided, system will use an \n Entity Resolution managed KMS key.
" - } - }, - "applyNormalization": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "Normalizes the attributes defined in the schema in the input data. For example, if an\n attribute has an AttributeType of PHONE_NUMBER, and the data in\n the input table is in a format of 1234567890, Entity Resolution will normalize this field\n in the output to (123)-456-7890.
A list of OutputAttribute objects, each of which have the fields Name and Hashed. Each of \n these objects selects a column to be included in the output table, and whether the \n values of the column should be hashed.
There are two types of matching, RULE_MATCHING and ML_MATCHING\n
An object which defines the list of matching rules to run and has a field Rules, which \n is a list of rule objects.
An object which defines the resolutionType and the ruleBasedProperties\n
The resource could not be found. HTTP Status Code: 404\n
A name for the matching rule.
", - "smithy.api#length": { - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$", - "smithy.api#required": {} - } - }, - "matchingKeys": { - "target": "com.amazonaws.entityresolution#MatchingKeys", - "traits": { - "smithy.api#documentation": "A list of MatchingKeys. The MatchingKeys must have been defined in \n the SchemaMapping. Two records are considered to match according to this rule if all \n of the MatchingKeys match.
An object containing RuleName, and MatchingKeys.
A list of Rule objects, each of which have fields RuleName and MatchingKeys.
You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When \n choosing MANY_TO_MANY, the system can match attribute across the sub-types of an attribute type. For \n example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, \n the two profiles are matched on the Email type. When choosing ONE_TO_ONE the system can only match if \n the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of \n the Email field of Profile B matches, the two profiles are matched on the Email type.
An object which defines the list of matching rules to run and has a field Rules, which \n is a list of rule objects.
A string containing the field name.
", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.entityresolution#SchemaAttributeType", - "traits": { - "smithy.api#documentation": "The type of the attribute, selected from a list of values.
", - "smithy.api#required": {} - } - }, - "groupName": { - "target": "com.amazonaws.entityresolution#AttributeName", - "traits": { - "smithy.api#documentation": "Instruct Entity Resolution to combine several columns into a unified column with the\n identical attribute type. For example, when working with columns such as first_name,\n middle_name, and last_name, assigning them a common GroupName will prompt\n Entity Resolution to concatenate them into a single value.
A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the MatchKey\n Address' to both attributes, Entity Resolution will match records\n across these fields to create a consolidated matching group. If no MatchKey is\n specified for a column, it won't be utilized for matching purposes but will still be\n included in the output table.
An object containing FieldField, Type, GroupName, \n and MatchKey.
The name of the schema.
", - "smithy.api#required": {} - } - }, - "schemaArn": { - "target": "com.amazonaws.entityresolution#SchemaMappingArn", - "traits": { - "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the\n SchemaMapping.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
An object containing SchemaName, SchemaArn, \n CreatedAt, andUpdatedAt.
Starts the MatchingJob of a workflow. The workflow must have previously been created \n using the CreateMatchingWorkflow endpoint.
The name of the matching job to be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#StartMatchingJobOutput": { - "type": "structure", - "members": { - "jobId": { - "target": "com.amazonaws.entityresolution#JobId", - "traits": { - "smithy.api#documentation": "The ID of the job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.entityresolution#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.entityresolution#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.entityresolution#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.entityresolution#TagKey" - }, - "value": { - "target": "com.amazonaws.entityresolution#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.entityresolution#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.entityresolution#TagResourceInput" - }, - "output": { - "target": "com.amazonaws.entityresolution#TagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.entityresolution#InternalServerException" - }, - { - "target": "com.amazonaws.entityresolution#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.entityresolution#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified AWS Entity Resolution\n resource. Tags can help you organize and categorize your resources. You can also use them\n to scope user permissions by granting a user permission to access or change only resources\n with certain tag values. In Entity Resolution, SchemaMapping, and\n MatchingWorkflow can be tagged. Tags don't have any semantic meaning to AWS\n and are interpreted strictly as strings of characters. You can use the\n TagResource action with a resource that already has tags. If you specify a\n new tag key, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you\n specify replaces the previous value for that tag.
The ARN of the resource for which you want to view tags.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.entityresolution#TagMap", - "traits": { - "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#TagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.entityresolution#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.entityresolution#ErrorMessage" - } - }, - "traits": { - "smithy.api#documentation": "The request was denied due to request throttling. HTTP Status Code: 429\n
Removes one or more tags from the specified AWS Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
The ARN of the resource for which you want to untag.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.entityresolution#TagKeyList", - "traits": { - "smithy.api#documentation": "The list of tag keys to remove from the resource.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#UntagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#UpdateMatchingWorkflow": { - "type": "operation", - "input": { - "target": "com.amazonaws.entityresolution#UpdateMatchingWorkflowInput" - }, - "output": { - "target": "com.amazonaws.entityresolution#UpdateMatchingWorkflowOutput" - }, - "errors": [ - { - "target": "com.amazonaws.entityresolution#AccessDeniedException" - }, - { - "target": "com.amazonaws.entityresolution#InternalServerException" - }, - { - "target": "com.amazonaws.entityresolution#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.entityresolution#ThrottlingException" - }, - { - "target": "com.amazonaws.entityresolution#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates an existing MatchingWorkflow. This method is identical to \n CreateMatchingWorkflow, except it uses an HTTP PUT request instead of \n a POST request, and the MatchingWorkflow must already exist for the \n method to succeed.
The name of the workflow to be retrieved.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.entityresolution#Description", - "traits": { - "smithy.api#documentation": "A description of the workflow.
" - } - }, - "inputSourceConfig": { - "target": "com.amazonaws.entityresolution#InputSourceConfig", - "traits": { - "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.entityresolution#UpdateMatchingWorkflowOutput": { - "type": "structure", - "members": { - "workflowName": { - "target": "com.amazonaws.entityresolution#EntityName", - "traits": { - "smithy.api#documentation": "The name of the workflow.
", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.entityresolution#Description", - "traits": { - "smithy.api#documentation": "A description of the workflow.
" - } - }, - "inputSourceConfig": { - "target": "com.amazonaws.entityresolution#InputSourceConfig", - "traits": { - "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.entityresolution#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.entityresolution#ErrorMessage" + ], + "version": "1.0" + } + } + }, + "com.amazonaws.entityresolution#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action. HTTP Status Code: 403\n
The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists, \n Schema already exists, Workflow is currently running, etc. HTTP Status Code: 400\n
Creates a MatchingWorkflow object which stores the configuration of the data processing job \n to be run. It is important to note that there should not be a pre-existing MatchingWorkflow \n with the same name. To modify an existing workflow, utilize the UpdateMatchingWorkflow API.
The name of the workflow. There cannot be multiple DataIntegrationWorkflows with the same name.
A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the\n ruleBasedProperties.
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#CreateMatchingWorkflowOutput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "workflowArn": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the\n ruleBasedProperties.
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#CreateSchemaMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#CreateSchemaMappingInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#CreateSchemaMappingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#ConflictException" + }, + { + "target": "com.amazonaws.entityresolution#ExceedsLimitException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a schema mapping, which defines the schema of the input customer records table.\n The SchemaMapping also provides Entity Resolution with some metadata about the\n table, such as the attribute types of the columns and which columns to match on.
The name of the schema. There cannot be multiple SchemaMappings with the\n same name.
A description of the schema.
" + } + }, + "mappedInputFields": { + "target": "com.amazonaws.entityresolution#SchemaInputAttributes", + "traits": { + "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#CreateSchemaMappingOutput": { + "type": "structure", + "members": { + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema.
", + "smithy.api#required": {} + } + }, + "schemaArn": { + "target": "com.amazonaws.entityresolution#SchemaMappingArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the\n SchemaMapping.
A description of the schema.
", + "smithy.api#required": {} + } + }, + "mappedInputFields": { + "target": "com.amazonaws.entityresolution#SchemaInputAttributes", + "traits": { + "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n that Entity Resolution uses for matching.
Deletes the MatchingWorkflow with a given name. This operation will succeed even if a \n workflow with the given name does not exist.
The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#DeleteMatchingWorkflowOutput": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A successful operation message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#DeleteSchemaMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#DeleteSchemaMappingInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#DeleteSchemaMappingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#ConflictException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the SchemaMapping with a given name. This operation will succeed even if a schema \n with the given name does not exist. This operation will fail if there is a DataIntegrationWorkflow \n object that references the SchemaMapping in the workflow's InputSourceConfig.
The name of the schema to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#DeleteSchemaMappingOutput": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A successful operation message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + } + } + }, + "com.amazonaws.entityresolution#EntityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9-]*$" + } + }, + "com.amazonaws.entityresolution#ErrorDetails": { + "type": "structure", + "members": { + "errorMessage": { + "target": "com.amazonaws.entityresolution#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message from the job, if there is one.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing an error message, if there was an error.
" + } + }, + "com.amazonaws.entityresolution#ErrorMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.entityresolution#ExceedsLimitException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + }, + "quotaName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the quota that has been breached.
" + } + }, + "quotaValue": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The current quota value for the customers.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits. \n The error message describes the limit exceeded. HTTP Status Code: 402\n
Returns the corresponding Match ID of a customer record if the record has been processed.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/matchingworkflows/{workflowName}/matches" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetMatchIdInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "record": { + "target": "com.amazonaws.entityresolution#RecordAttributeMap", + "traits": { + "smithy.api#documentation": "The record to fetch the Match ID for.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetMatchIdOutput": { + "type": "structure", + "members": { + "matchId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifiers for this group of match records.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetMatchingJobInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetMatchingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the status, metrics, and errors (if there are any) that are associated with a job.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/matchingworkflows/{workflowName}/jobs/{jobId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJobInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingJobOutput": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.entityresolution#JobStatus", + "traits": { + "smithy.api#documentation": "The current status of the job.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job was started.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job has finished.
" + } + }, + "metrics": { + "target": "com.amazonaws.entityresolution#JobMetrics", + "traits": { + "smithy.api#documentation": "Metrics associated with the execution, specifically total records processed, \n unique IDs generated, and records the execution skipped.
" + } + }, + "errorDetails": { + "target": "com.amazonaws.entityresolution#ErrorDetails", + "traits": { + "smithy.api#documentation": "An object containing an error message, if there was an error.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetMatchingWorkflowInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetMatchingWorkflowOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the MatchingWorkflow with a given name, if it exists.
The name of the workflow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetMatchingWorkflowOutput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "workflowArn": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the\n ruleBasedProperties.
The timestamp of when the workflow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the workflow was last updated.
", + "smithy.api#required": {} + } + }, + "incrementalRunConfig": { + "target": "com.amazonaws.entityresolution#IncrementalRunConfig", + "traits": { + "smithy.api#documentation": "An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role to access \n resources on your behalf.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#GetSchemaMapping": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#GetSchemaMappingInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#GetSchemaMappingOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the SchemaMapping of a given name.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/schemas/{schemaName}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#GetSchemaMappingInput": { + "type": "structure", + "members": { + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#GetSchemaMappingOutput": { + "type": "structure", + "members": { + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema.
", + "smithy.api#required": {} + } + }, + "schemaArn": { + "target": "com.amazonaws.entityresolution#SchemaMappingArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "A description of the schema.
" + } + }, + "mappedInputFields": { + "target": "com.amazonaws.entityresolution#SchemaInputAttributes", + "traits": { + "smithy.api#documentation": "A list of MappedInputFields. Each MappedInputField corresponds\n to a column the source data table, and contains column name plus additional information\n Venice uses for matching.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#IncrementalRunConfig": { + "type": "structure", + "members": { + "incrementalRunType": { + "target": "com.amazonaws.entityresolution#IncrementalRunType", + "traits": { + "smithy.api#documentation": "The type of incremental run. It takes only one value: IMMEDIATE.
An object which defines an incremental run type and has only incrementalRunType as a field.
An Glue table ARN for the input source table.
", + "smithy.api#pattern": "^arn:aws:.*:.*:[0-9]+:.*$", + "smithy.api#required": {} + } + }, + "schemaName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the schema to be retrieved.
", + "smithy.api#required": {} + } + }, + "applyNormalization": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Normalizes the attributes defined in the schema in the input data. For example, if an\n attribute has an AttributeType of PHONE_NUMBER, and the data in\n the input table is in a format of 1234567890, Entity Resolution will normalize this field\n in the output to (123)-456-7890.
An object containing InputSourceARN, SchemaName, \n and ApplyNormalization.
This exception occurs when there is an internal failure in the Entity Resolution service. HTTP Status Code: 500\n
The total number of input records.
" + } + }, + "totalRecordsProcessed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of records processed.
" + } + }, + "recordsNotProcessed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of records that did not get processed.
" + } + }, + "matchIDs": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The total number of matchIDs generated.
An object containing InputRecords, TotalRecordsProcessed, \n MatchIDs, and RecordsNotProcessed.
The ID of the job.
", + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.entityresolution#JobStatus", + "traits": { + "smithy.api#documentation": "The current status of the job.
", + "smithy.api#required": {} + } + }, + "startTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job was started.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the job has finished.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing the JobId, Status, \n StartTime, and EndTime of a job.
Lists all jobs for a given workflow.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/matchingworkflows/{workflowName}/jobs" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobs" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.entityresolution#ListMatchingJobsInput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.entityresolution#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListMatchingJobsOutput": { + "type": "structure", + "members": { + "jobs": { + "target": "com.amazonaws.entityresolution#JobList", + "traits": { + "smithy.api#documentation": "A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.
The pagination token from the previous ListSchemaMappings API call.
Returns a list of all the MatchingWorkflows that have been created for an Amazon Web Services account.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "max": 25 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListMatchingWorkflowsOutput": { + "type": "structure", + "members": { + "workflowSummaries": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowList", + "traits": { + "smithy.api#documentation": "A list of MatchingWorkflowSummary objects, each of which contain the fields \n WorkflowName, WorkflowArn, CreatedAt, and UpdatedAt.
The pagination token from the previous ListSchemaMappings API call.
Returns a list of all the SchemaMappings that have been created for an Amazon Web Services account.
The pagination token from the previous ListSchemaMappings API call.
The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "max": 25 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListSchemaMappingsOutput": { + "type": "structure", + "members": { + "schemaList": { + "target": "com.amazonaws.entityresolution#SchemaMappingList", + "traits": { + "smithy.api#documentation": "A list of SchemaMappingSummary objects, each of which contain the fields \n SchemaName, SchemaArn, CreatedAt, UpdatedAt.
The pagination token from the previous ListDomains API call.
Displays the tags associated with an Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
The ARN of the resource for which you want to view tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#MatchingKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#AttributeName" + } + }, + "com.amazonaws.entityresolution#MatchingWorkflowArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:(aws|aws-us-gov|aws-cn):entityresolution:.*:[0-9]+:(matchingworkflow/.*)$" + } + }, + "com.amazonaws.entityresolution#MatchingWorkflowList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowSummary" + } + }, + "com.amazonaws.entityresolution#MatchingWorkflowSummary": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "workflowArn": { + "target": "com.amazonaws.entityresolution#MatchingWorkflowArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the MatchingWorkflow.
The timestamp of when the workflow was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the workflow was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A list of MatchingWorkflowSummary objects, each of which contain the fields \n WorkflowName, WorkflowArn, CreatedAt, UpdatedAt.
A name of a column to be written to the output. This must be an InputField name \n in the schema mapping.
Enables the ability to hash the column values in the output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.
The S3 path to which Entity Resolution will write the output table.
", + "smithy.api#required": {} + } + }, + "KMSArn": { + "target": "com.amazonaws.entityresolution#KMSArn", + "traits": { + "smithy.api#documentation": "Customer KMS ARN for encryption at rest. If not provided, system will use an \n Entity Resolution managed KMS key.
" + } + }, + "output": { + "target": "com.amazonaws.entityresolution#OutputAttributes", + "traits": { + "smithy.api#documentation": "A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.
Normalizes the attributes defined in the schema in the input data. For example, if an\n attribute has an AttributeType of PHONE_NUMBER, and the data in\n the input table is in a format of 1234567890, Entity Resolution will normalize this field\n in the output to (123)-456-7890.
A list of OutputAttribute objects, each of which have the fields\n Name and Hashed. Each of these objects selects a column to be\n included in the output table, and whether the values of the column should be hashed.
The type of matching. There are two types of matching: RULE_MATCHING and\n ML_MATCHING.
An object which defines the list of matching rules to run and has a field Rules, which \n is a list of rule objects.
An object which defines the resolutionType and the\n ruleBasedProperties.
The resource could not be found. HTTP Status Code: 404\n
A name for the matching rule.
", + "smithy.api#length": { + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z_0-9- \\t]*$", + "smithy.api#required": {} + } + }, + "matchingKeys": { + "target": "com.amazonaws.entityresolution#MatchingKeys", + "traits": { + "smithy.api#documentation": "A list of MatchingKeys. The MatchingKeys must have been defined in \n the SchemaMapping. Two records are considered to match according to this rule if all \n of the MatchingKeys match.
An object containing RuleName, and MatchingKeys.
A list of Rule objects, each of which have fields RuleName and\n MatchingKeys.
The comparison type. You can either choose ONE_TO_ONE or MANY_TO_MANY as the AttributeMatchingModel. When \n choosing MANY_TO_MANY, the system can match attributes across the sub-types of an attribute type. For \n example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches, \n the two profiles are matched on the Email type. When choosing ONE_TO_ONE ,the system can only match if \n the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of \n the Email field of Profile B matches, the two profiles are matched on the Email type.
An object which defines the list of matching rules to run and has a field Rules, which \n is a list of rule objects.
A string containing the field name.
", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.entityresolution#SchemaAttributeType", + "traits": { + "smithy.api#documentation": "The type of the attribute, selected from a list of values.
", + "smithy.api#required": {} + } + }, + "groupName": { + "target": "com.amazonaws.entityresolution#AttributeName", + "traits": { + "smithy.api#documentation": "Instruct Entity Resolution to combine several columns into a unified column with the\n identical attribute type. For example, when working with columns such as first_name,\n middle_name, and last_name, assigning them a common GroupName will prompt\n Entity Resolution to concatenate them into a single value.
A key that allows grouping of multiple input attributes into a unified matching group.\n For example, let's consider a scenario where the source table contains various addresses,\n such as business_address and shipping_address. By assigning the MatchKey\n Address to both attributes, Entity Resolution will match records across these\n fields to create a consolidated matching group. If no MatchKey is specified\n for a column, it won't be utilized for matching purposes but will still be included in the\n output table.
An object containing FieldField, Type, GroupName, \n and MatchKey.
The name of the schema.
", + "smithy.api#required": {} + } + }, + "schemaArn": { + "target": "com.amazonaws.entityresolution#SchemaMappingArn", + "traits": { + "smithy.api#documentation": "The ARN (Amazon Resource Name) that Entity Resolution generated for the\n SchemaMapping.
The timestamp of when the SchemaMapping was created.
The timestamp of when the SchemaMapping was last updated.
An object containing SchemaName, SchemaArn, \n CreatedAt, andUpdatedAt.
Starts the MatchingJob of a workflow. The workflow must have previously been created \n using the CreateMatchingWorkflow endpoint.
The name of the matching job to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#StartMatchingJobOutput": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.entityresolution#JobId", + "traits": { + "smithy.api#documentation": "The ID of the job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.entityresolution#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.entityresolution#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.entityresolution#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.entityresolution#TagKey" + }, + "value": { + "target": "com.amazonaws.entityresolution#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.entityresolution#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified Entity Resolution\n resource. Tags can help you organize and categorize your resources. You can also use them\n to scope user permissions by granting a user permission to access or change only resources\n with certain tag values. In Entity Resolution, SchemaMapping and\n MatchingWorkflow can be tagged. Tags don't have any semantic meaning to Amazon Web Services\n and are interpreted strictly as strings of characters. You can use the\n TagResource action with a resource that already has tags. If you specify a\n new tag key, this tag is appended to the list of tags associated with the resource. If you\n specify a tag key that is already associated with the resource, the new tag value that you\n specify replaces the previous value for that tag.
The ARN of the resource for which you want to view tags.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.entityresolution#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.entityresolution#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling. HTTP Status Code: 429\n
Removes one or more tags from the specified Entity Resolution resource. In Entity\n Resolution, SchemaMapping, and MatchingWorkflow can be\n tagged.
The ARN of the resource for which you want to untag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.entityresolution#TagKeyList", + "traits": { + "smithy.api#documentation": "The list of tag keys to remove from the resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#UpdateMatchingWorkflow": { + "type": "operation", + "input": { + "target": "com.amazonaws.entityresolution#UpdateMatchingWorkflowInput" + }, + "output": { + "target": "com.amazonaws.entityresolution#UpdateMatchingWorkflowOutput" + }, + "errors": [ + { + "target": "com.amazonaws.entityresolution#AccessDeniedException" + }, + { + "target": "com.amazonaws.entityresolution#InternalServerException" + }, + { + "target": "com.amazonaws.entityresolution#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.entityresolution#ThrottlingException" + }, + { + "target": "com.amazonaws.entityresolution#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing MatchingWorkflow. This method is identical to \n CreateMatchingWorkflow, except it uses an HTTP PUT request instead of \n a POST request, and the MatchingWorkflow must already exist for the \n method to succeed.
The name of the workflow to be retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties.
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.entityresolution#UpdateMatchingWorkflowOutput": { + "type": "structure", + "members": { + "workflowName": { + "target": "com.amazonaws.entityresolution#EntityName", + "traits": { + "smithy.api#documentation": "The name of the workflow.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.entityresolution#Description", + "traits": { + "smithy.api#documentation": "A description of the workflow.
" + } + }, + "inputSourceConfig": { + "target": "com.amazonaws.entityresolution#InputSourceConfig", + "traits": { + "smithy.api#documentation": "A list of InputSource objects, which have the fields InputSourceARN and \n SchemaName.
A list of OutputSource objects, each of which contains fields OutputS3Path, \n ApplyNormalization, and Output.
An object which defines the resolutionType and the ruleBasedProperties\n
An object which defines an incremental run type and has only incrementalRunType as a field.
The Amazon Resource Name (ARN) of the IAM role. Entity Resolution assumes this role\n to create resources on your behalf as part of workflow execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.entityresolution#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.entityresolution#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by Entity Resolution. HTTP Status Code: 400\n
The input fails to satisfy the constraints specified by AWS Entity Resolution. HTTP Status Code: 400\n
Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify\n anomalies in machines from sensor data for use in predictive maintenance.
", - "smithy.api#title": "Amazon Lookout for Equipment", - "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": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, { - "conditions": [ + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.lookoutequipment#AWSLookoutEquipmentFrontendService": { + "type": "service", + "version": "2020-12-15", + "operations": [ { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.lookoutequipment#CreateDataset" + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.lookoutequipment#CreateInferenceScheduler" }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.lookoutequipment#CreateLabel" }, { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [ + "target": "com.amazonaws.lookoutequipment#CreateLabelGroup" + }, { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "type": "tree", - "rules": [ + "target": "com.amazonaws.lookoutequipment#CreateModel" + }, { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ + "target": "com.amazonaws.lookoutequipment#CreateRetrainingScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#DeleteDataset" + }, + { + "target": "com.amazonaws.lookoutequipment#DeleteInferenceScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#DeleteLabel" + }, + { + "target": "com.amazonaws.lookoutequipment#DeleteLabelGroup" + }, + { + "target": "com.amazonaws.lookoutequipment#DeleteModel" + }, + { + "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicy" + }, + { + "target": "com.amazonaws.lookoutequipment#DeleteRetrainingScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJob" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeDataset" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeInferenceScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeLabel" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeLabelGroup" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeModel" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersion" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicy" + }, + { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#ImportDataset" + }, + { + "target": "com.amazonaws.lookoutequipment#ImportModelVersion" + }, + { + "target": "com.amazonaws.lookoutequipment#ListDataIngestionJobs" + }, + { + "target": "com.amazonaws.lookoutequipment#ListDatasets" + }, + { + "target": "com.amazonaws.lookoutequipment#ListInferenceEvents" + }, + { + "target": "com.amazonaws.lookoutequipment#ListInferenceExecutions" + }, + { + "target": "com.amazonaws.lookoutequipment#ListInferenceSchedulers" + }, + { + "target": "com.amazonaws.lookoutequipment#ListLabelGroups" + }, + { + "target": "com.amazonaws.lookoutequipment#ListLabels" + }, + { + "target": "com.amazonaws.lookoutequipment#ListModels" + }, + { + "target": "com.amazonaws.lookoutequipment#ListModelVersions" + }, + { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulers" + }, + { + "target": "com.amazonaws.lookoutequipment#ListSensorStatistics" + }, + { + "target": "com.amazonaws.lookoutequipment#ListTagsForResource" + }, + { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicy" + }, + { + "target": "com.amazonaws.lookoutequipment#StartDataIngestionJob" + }, + { + "target": "com.amazonaws.lookoutequipment#StartInferenceScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#StartRetrainingScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#StopInferenceScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#StopRetrainingScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#TagResource" + }, + { + "target": "com.amazonaws.lookoutequipment#UntagResource" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersion" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateInferenceScheduler" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateLabelGroup" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateModel" + }, + { + "target": "com.amazonaws.lookoutequipment#UpdateRetrainingScheduler" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "LookoutEquipment", + "arnNamespace": "lookoutequipment", + "cloudFormationName": "LookoutEquipment", + "cloudTrailEventSource": "lookoutequipment.amazonaws.com", + "endpointPrefix": "lookoutequipment" + }, + "aws.auth#sigv4": { + "name": "lookoutequipment" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon Lookout for Equipment is a machine learning service that uses advanced analytics to identify\n anomalies in machines from sensor data for use in predictive maintenance.
", + "smithy.api#title": "Amazon Lookout for Equipment", + "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" + } + ] + } + ], + "type": "tree", + "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" + } + ] + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://lookoutequipment.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { - "ref": "Region" + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "assign": "PartitionResult" - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.ap-northeast-2.amazonaws.com" + } }, - true - ] + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.eu-west-1.amazonaws.com" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.us-east-1.amazonaws.com" } - ] }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.us-east-1.api.aws" } - ] + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } - ] }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.cn-north-1.api.amazonwebservices.com.cn" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.cn-north-1.amazonaws.com.cn" } - ] + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutequipment-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true } - ] }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.us-gov-east-1.api.aws" + } }, - true - ] - } - ], - "type": "tree", - "rules": [ + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment-fips.us-gov-east-1.amazonaws.com" } - ] + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://lookoutequipment.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true } - ] }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ] - }, - { - "conditions": [], - "endpoint": { - "url": "https://lookoutequipment.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment.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://lookoutequipment.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 enabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment-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://lookoutequipment-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://lookoutequipment.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://lookoutequipment-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://lookoutequipment-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://lookoutequipment.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://lookoutequipment.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://lookoutequipment-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 disabled", + "expect": { + "endpoint": { + "url": "https://lookoutequipment.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://lookoutequipment-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://lookoutequipment.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://lookoutequipment-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://lookoutequipment.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.lookoutequipment#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "The request could not be completed because you do not have access to the resource.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.lookoutequipment#AmazonResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, + "com.amazonaws.lookoutequipment#AutoPromotionResult": { + "type": "enum", + "members": { + "MODEL_PROMOTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_PROMOTED" + } + }, + "MODEL_NOT_PROMOTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MODEL_NOT_PROMOTED" + } + }, + "RETRAINING_INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_INTERNAL_ERROR" + } + }, + "RETRAINING_CUSTOMER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_CUSTOMER_ERROR" + } + }, + "RETRAINING_CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING_CANCELLED" + } + } + } + }, + "com.amazonaws.lookoutequipment#AutoPromotionResultReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.lookoutequipment#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.lookoutequipment#BoundedLengthString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,5000}$" + } + }, + "com.amazonaws.lookoutequipment#CategoricalValues": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "Indicates whether there is a potential data issue related to categorical values.\n
", + "smithy.api#required": {} + } + }, + "NumberOfCategory": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of categories in the data.
" + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } + "traits": { + "smithy.api#documentation": "Entity that comprises information on categorical values in data.
" + } + }, + "com.amazonaws.lookoutequipment#Comments": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2560 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,2560}$" + } + }, + "com.amazonaws.lookoutequipment#ComponentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._\\-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#ComponentTimestampDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + }, + "smithy.api#pattern": "^(\\-|\\_|\\s)?$" + } + }, + "com.amazonaws.lookoutequipment#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#required": {} + } + } }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#documentation": "The request could not be completed due to a conflict with the current state of the\n target resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.lookoutequipment#CountPercent": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the count of occurences of the given statistic.
", + "smithy.api#required": {} + } + }, + "Percentage": { + "target": "com.amazonaws.lookoutequipment#Float", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Indicates the percentage of occurances of the given statistic.
", + "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#documentation": "Entity that comprises information of count and percentage.
" + } + }, + "com.amazonaws.lookoutequipment#CreateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#CreateDatasetRequest" }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } + "output": { + "target": "com.amazonaws.lookoutequipment#CreateDatasetResponse" }, - { - "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.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a container for a collection of data being ingested for analysis. The dataset\n contains the metadata describing where the data is and what the data actually looks like.\n For example, it contains the location of the data source, the data schema, and other\n information. A dataset also contains any tags associated with the ingested data.
" + } + }, + "com.amazonaws.lookoutequipment#CreateDatasetRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset being created.
", + "smithy.api#required": {} + } + }, + "DatasetSchema": { + "target": "com.amazonaws.lookoutequipment#DatasetSchema", + "traits": { + "smithy.api#documentation": "A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.
" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout\n for Equipment.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "Any tags associated with the ingested data described in the dataset.
" + } + } }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateDatasetResponse": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset being created.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset being created.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#DatasetStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the CreateDataset operation.
Creates a scheduled inference. Scheduling an inference is setting up a continuous\n real-time inference plan to analyze new measurement data. When setting up the schedule, you\n provide an S3 bucket location for the input data, assign it a delimiter between separate\n entries in the data, set an offset delay if desired, and set the frequency of inferencing.\n You must also provide an S3 bucket location for the output data.
" + } + }, + "com.amazonaws.lookoutequipment#CreateInferenceSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the previously trained machine learning model being used to create the\n inference scheduler.
", + "smithy.api#required": {} + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler being created.
", + "smithy.api#required": {} + } + }, + "DataDelayOffsetInMinutes": { + "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", + "traits": { + "smithy.api#documentation": "The interval (in minutes) of planned delay at the start of each inference segment. For\n example, if inference is set to run every ten minutes, the delay is set to five minutes and\n the time is 09:08. The inference scheduler will wake up at the configured interval (which,\n without a delay configured, would be 09:10) plus the additional five minute delay time (so\n 09:15) to check your Amazon S3 bucket. The delay provides a buffer for you to upload data at the\n same frequency, so that you don't have to stop and restart the scheduler when uploading new\n data.
\nFor more information, see Understanding\n the inference process.
" + } + }, + "DataUploadFrequency": { + "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", + "traits": { + "smithy.api#documentation": "How often data is uploaded to the source Amazon S3 bucket for the input data. The value\n chosen is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This\n frequency also determines how often Amazon Lookout for Equipment runs inference on your data.
\nFor more information, see Understanding\n the inference process.
", + "smithy.api#required": {} + } + }, + "DataInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference scheduler,\n including delimiter, format, and dataset location.
", + "smithy.api#required": {} + } + }, + "DataOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the output results for the inference scheduler,\n including the S3 location for the output.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source being\n used for the inference.
", + "smithy.api#required": {} + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt inference scheduler data by\n Amazon Lookout for Equipment.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "Any tags associated with the inference scheduler.
" + } + } }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://lookoutequipment.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateInferenceSchedulerResponse": { + "type": "structure", + "members": { + "InferenceSchedulerArn": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being created.
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of inference scheduler being created.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the CreateInferenceScheduler operation.
Creates a label for an event.
" + } + }, + "com.amazonaws.lookoutequipment#CreateLabelGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#CreateLabelGroupRequest" }, - { - "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.lookoutequipment#CreateLabelGroupResponse" }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a group of labels.
" + } + }, + "com.amazonaws.lookoutequipment#CreateLabelGroupRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "Names a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
", + "smithy.api#required": {} + } + }, + "FaultCodes": { + "target": "com.amazonaws.lookoutequipment#FaultCodes", + "traits": { + "smithy.api#documentation": "The acceptable fault codes (indicating the type of anomaly associated with the label)\n that can be used with this label group.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request to create a label group. If you do not set the\n client request token, Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "Tags that provide metadata about the label group you are creating.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateLabelGroupResponse": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group that you have created. Data in this field will be retained\n for service usage. Follow best practices for the security of your data.
" + } + }, + "LabelGroupArn": { + "target": "com.amazonaws.lookoutequipment#LabelGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group that you have created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#CreateLabelRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the labeled event.
", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the labeled event.
", + "smithy.api#required": {} + } + }, + "Rating": { + "target": "com.amazonaws.lookoutequipment#LabelRating", + "traits": { + "smithy.api#documentation": "Indicates whether a labeled event represents an anomaly.
", + "smithy.api#required": {} + } + }, + "FaultCode": { + "target": "com.amazonaws.lookoutequipment#FaultCode", + "traits": { + "smithy.api#documentation": "Provides additional information about the label. The fault code must be defined in the\n FaultCodes attribute of the label group.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + }, + "Notes": { + "target": "com.amazonaws.lookoutequipment#Comments", + "traits": { + "smithy.api#documentation": "Metadata providing additional information about the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + }, + "Equipment": { + "target": "com.amazonaws.lookoutequipment#Equipment", + "traits": { + "smithy.api#documentation": "Indicates that a label pertains to a particular piece of equipment.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request to create a label. If you do not set the client\n request token, Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateLabelResponse": { + "type": "structure", + "members": { + "LabelId": { + "target": "com.amazonaws.lookoutequipment#LabelId", + "traits": { + "smithy.api#documentation": "The ID of the label that you have created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#CreateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#CreateModelRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#CreateModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a machine learning model for data inference.
\nA machine-learning (ML) model is a mathematical model that finds patterns in your data.\n In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal\n behavior that could be potential equipment failure (or maintenance events). The models are\n made by analyzing normal data and abnormalities in machine behavior that have already\n occurred.
\nYour model is trained using a portion of the data from your dataset and uses that data\n to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.\n Another portion of the data is used to evaluate the model's accuracy.
" + } + }, + "com.amazonaws.lookoutequipment#CreateModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name for the machine learning model to be created.
", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "The name of the dataset for the machine learning model being created.
", + "smithy.api#required": {} + } + }, + "DatasetSchema": { + "target": "com.amazonaws.lookoutequipment#DatasetSchema", + "traits": { + "smithy.api#documentation": "The data schema for the machine learning model being created.
" + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration", + "traits": { + "smithy.api#documentation": "The input configuration for the labels being used for the machine learning model that's\n being created.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "TrainingDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n training data for the machine learning model.
" + } + }, + "TrainingDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n training data for the machine learning model.
" + } + }, + "EvaluationDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n evaluation data for the machine learning model.
" + } + }, + "EvaluationDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n evaluation data for the machine learning model.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source\n being used to create the machine learning model.
" + } + }, + "DataPreProcessingConfiguration": { + "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout\n for Equipment.
" + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "Any tags associated with the machine learning model being created.
" + } + }, + "OffCondition": { + "target": "com.amazonaws.lookoutequipment#OffCondition", + "traits": { + "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateModelResponse": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model being created.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the CreateModel operation.
Creates a retraining scheduler on the specified model.
", + "smithy.api#examples": [ + { + "title": "Creates a retraining scheduler with manual promote mode", + "documentation": "", + "input": { + "ModelName": "sample-model", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D", + "PromoteMode": "MANUAL", + "ClientToken": "sample-client-token" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "PENDING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model to add the retraining scheduler to.
", + "smithy.api#required": {} + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in\n terms of Years, Months, and/or Days (note: other parameters like Time are not currently\n supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For\n example, the following values are valid:
\nP3M15D – Every 3 months and 15 days
\nP2M – Every 2 months
\nP150D – Every 150 days
\nThe number of past days of data that will be used for retraining.
", + "smithy.api#required": {} + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "Indicates how the service will use new models. In MANAGED mode, new models\n will automatically be used for inference if they have better performance than the current\n model. In MANUAL mode, the new models will not be used until they\n are manually activated.
A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#CreateRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that you added the retraining scheduler to.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model that you added the retraining scheduler to.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 60 + } + } + }, + "com.amazonaws.lookoutequipment#DataIngestionJobSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#DataIngestionJobSummary" + } + }, + "com.amazonaws.lookoutequipment#DataIngestionJobSummary": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { + "smithy.api#documentation": "Indicates the job ID of the data ingestion job.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset used for the data ingestion job.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used in the data ingestion job.
" + } + }, + "IngestionInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies information for the input data for the data inference job, including data\n Amazon S3 location parameters.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the data ingestion job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about a specified data ingestion job, including dataset\n information, data ingestion configuration, and status.
" + } + }, + "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration": { + "type": "structure", + "members": { + "TargetSamplingRate": { + "target": "com.amazonaws.lookoutequipment#TargetSamplingRate", + "traits": { + "smithy.api#documentation": "The sampling rate of the data after post processing by Amazon Lookout for Equipment. For example, if you\n provide data that has been collected at a 1 second level and you want the system to\n resample the data at a 1 minute rate before training, the TargetSamplingRate\n is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Parameter that gives information about insufficient data for sensors in the dataset.\n This includes information about those sensors that have complete data missing and those\n with a short date range.
", + "smithy.api#required": {} + } + }, + "MissingSensorData": { + "target": "com.amazonaws.lookoutequipment#MissingSensorData", + "traits": { + "smithy.api#documentation": "Parameter that gives information about data that is missing over all the sensors in the\n input data.
", + "smithy.api#required": {} + } + }, + "InvalidSensorData": { + "target": "com.amazonaws.lookoutequipment#InvalidSensorData", + "traits": { + "smithy.api#documentation": "Parameter that gives information about data that is invalid over all the sensors in the\n input data.
", + "smithy.api#required": {} + } + }, + "UnsupportedTimestamps": { + "target": "com.amazonaws.lookoutequipment#UnsupportedTimestamps", + "traits": { + "smithy.api#documentation": "Parameter that gives information about unsupported timestamps in the input data.\n
", + "smithy.api#required": {} + } + }, + "DuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#DuplicateTimestamps", + "traits": { + "smithy.api#documentation": "Parameter that gives information about duplicate timestamps in the input data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "DataQualitySummary gives aggregated statistics over all the sensors about a completed\n ingestion job. It primarily gives more information about statistics over different\n incorrect data like MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,\n InsufficientSensorData, DuplicateTimeStamps.
" + } + }, + "com.amazonaws.lookoutequipment#DataSizeInBytes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.lookoutequipment#DataUploadFrequency": { + "type": "enum", + "members": { + "PT5M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5M" + } + }, + "PT10M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10M" + } + }, + "PT15M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15M" + } + }, + "PT30M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30M" + } + }, + "PT1H": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1H" + } + } + } + }, + "com.amazonaws.lookoutequipment#DatasetArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:dataset\\/.+$" + } + }, + "com.amazonaws.lookoutequipment#DatasetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#DatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#DatasetSchema": { + "type": "structure", + "members": { + "InlineDataSchema": { + "target": "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema", + "traits": { + "smithy.api#documentation": "The data schema used within the given dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the data schema used with the given dataset.
" + } + }, + "com.amazonaws.lookoutequipment#DatasetStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "INGESTION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION_IN_PROGRESS" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.lookoutequipment#DatasetSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#DatasetSummary" + } + }, + "com.amazonaws.lookoutequipment#DatasetSummary": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified dataset.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#DatasetStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the dataset.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the dataset was created in Amazon Lookout for Equipment.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the specific data set, including name, ARN, and status.\n
" + } + }, + "com.amazonaws.lookoutequipment#DeleteDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteDatasetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a dataset and associated artifacts. The operation will check to see if any\n inference scheduler or data ingestion job is currently using the dataset, and if there\n isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted.\n This does not affect any models that used this dataset for training and evaluation, but\n does prevent it from being used in the future.
" + } + }, + "com.amazonaws.lookoutequipment#DeleteDatasetRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "The name of the dataset to be deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteInferenceScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteInferenceSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an inference scheduler that has been set up. Prior inference results will not be\n deleted.
" + } + }, + "com.amazonaws.lookoutequipment#DeleteInferenceSchedulerRequest": { + "type": "structure", + "members": { + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler to be deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteLabel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteLabelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a label.
" + } + }, + "com.amazonaws.lookoutequipment#DeleteLabelGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a group of labels.
" + } + }, + "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group that you want to delete. Data in this field will be\n retained for service usage. Follow best practices for the security of your data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteLabelRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group that contains the label that you want to delete. Data in\n this field will be retained for service usage. Follow best practices for the security of\n your data.
", + "smithy.api#required": {} + } + }, + "LabelId": { + "target": "com.amazonaws.lookoutequipment#LabelId", + "traits": { + "smithy.api#documentation": "The ID of the label that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it\n from being used with an inference scheduler, even one that is already set up.
" + } + }, + "com.amazonaws.lookoutequipment#DeleteModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model to be deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the resource policy attached to the resource.
" + } + }, + "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the resource policy should be\n deleted.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DeleteRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DeleteRetrainingSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a retraining scheduler from a model. The retraining scheduler must be in the\n STOPPED status.
The name of the model whose retraining scheduler you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeDataIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides information on a specific data ingestion job such as creation time, dataset\n ARN, and status.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { + "smithy.api#documentation": "The job ID of the data ingestion job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { + "smithy.api#documentation": "Indicates the job ID of the data ingestion job.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.\n
" + } + }, + "IngestionInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the S3 location configuration for the data input for the data ingestion job.\n
" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source\n being ingested.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the data ingestion job was created.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the DataIngestionJob operation.
Specifies the reason for failure when a data ingestion job has failed.
" + } + }, + "DataQualitySummary": { + "target": "com.amazonaws.lookoutequipment#DataQualitySummary", + "traits": { + "smithy.api#documentation": "Gives statistics about a completed ingestion job. These statistics primarily relate to\n quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData,\n UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.
" + } + }, + "IngestedFilesSummary": { + "target": "com.amazonaws.lookoutequipment#IngestedFilesSummary" + }, + "StatusDetail": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "Provides details about status of the ingestion job that is currently in progress.\n
" + } + }, + "IngestedDataSize": { + "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", + "traits": { + "smithy.api#documentation": "Indicates the size of the ingested dataset.
" + } + }, + "DataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the earliest timestamp corresponding to data that was successfully ingested\n during this specific ingestion job.
" + } + }, + "DataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the latest timestamp corresponding to data that was successfully ingested\n during this specific ingestion job.
" + } + }, + "SourceDatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the data used for the\n data ingestion job was imported from.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a JSON description of the data in each time series dataset, including names,\n column names, and data types.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeDatasetRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "The name of the dataset to be described.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeDatasetResponse": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset being described.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset being described.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Specifies the time the dataset was created in Lookout for Equipment.
" + } + }, + "LastUpdatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Specifies the time the dataset was last updated, if it was.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#DatasetStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the dataset.
" + } + }, + "Schema": { + "target": "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema", + "traits": { + "smithy.api#documentation": "A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.
" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#KmsKeyArn", + "traits": { + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout\n for Equipment.
" + } + }, + "IngestionInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies the S3 location configuration for the data input for the data ingestion job.\n
" + } + }, + "DataQualitySummary": { + "target": "com.amazonaws.lookoutequipment#DataQualitySummary", + "traits": { + "smithy.api#documentation": "Gives statistics associated with the given dataset for the latest successful associated\n ingestion job id. These statistics primarily relate to quantifying incorrect data such as\n MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,\n InsufficientSensorData, and DuplicateTimeStamps.
" + } + }, + "IngestedFilesSummary": { + "target": "com.amazonaws.lookoutequipment#IngestedFilesSummary", + "traits": { + "smithy.api#documentation": "IngestedFilesSummary associated with the given dataset for the latest successful\n associated ingestion job id.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you are using for this the data\n ingestion job.
" + } + }, + "DataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the earliest timestamp corresponding to data that was successfully ingested\n during the most recent ingestion of this particular dataset.
" + } + }, + "DataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the latest timestamp corresponding to data that was successfully ingested\n during the most recent ingestion of this particular dataset.
" + } + }, + "SourceDatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the current data being\n described was imported from.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeInferenceScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Specifies information about the inference scheduler being used, including name, model,\n status, and associated metadata
" + } + }, + "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerRequest": { + "type": "structure", + "members": { + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler being described.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerResponse": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler\n being described.
" + } + }, + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model of the inference scheduler being described.\n
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler being described.
" + } + }, + "InferenceSchedulerArn": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being described.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the inference scheduler.
" + } + }, + "DataDelayOffsetInMinutes": { + "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", + "traits": { + "smithy.api#documentation": "A period of time (in minutes) by which inference on the data is delayed after the data\n starts. For instance, if you select an offset delay time of five minutes, inference will\n not begin on the data until the first data measurement after the five minute mark. For\n example, if five minutes is selected, the inference scheduler will wake up at the\n configured frequency with the additional five minute delay time to check the customer S3\n bucket. The customer can upload data at the same frequency and they don't need to stop and\n restart the scheduler when uploading new data.
" + } + }, + "DataUploadFrequency": { + "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", + "traits": { + "smithy.api#documentation": "Specifies how often data is uploaded to the source S3 bucket for the input data. This\n value is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This\n frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In\n this example, it starts once every 5 minutes.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Specifies the time at which the inference scheduler was created.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Specifies the time at which the inference scheduler was last updated, if it was.
" + } + }, + "DataInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference scheduler,\n including delimiter, format, and dataset location.
" + } + }, + "DataOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies information for the output results for the inference scheduler, including\n the output S3 location.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the inference scheduler being described.
" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#KmsKeyArn", + "traits": { + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt inference scheduler data by\n Amazon Lookout for Equipment.
" + } + }, + "LatestInferenceResult": { + "target": "com.amazonaws.lookoutequipment#LatestInferenceResult", + "traits": { + "smithy.api#documentation": "Indicates whether the latest execution for the inference scheduler was Anomalous\n (anomalous events found) or Normal (no anomalous events found).
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeLabel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeLabelRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeLabelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the name of the label.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeLabelGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeLabelGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the label group.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "Returns the name of the label group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeLabelGroupResponse": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group.
" + } + }, + "LabelGroupArn": { + "target": "com.amazonaws.lookoutequipment#LabelGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group.
" + } + }, + "FaultCodes": { + "target": "com.amazonaws.lookoutequipment#FaultCodes", + "traits": { + "smithy.api#documentation": "Codes indicating the type of anomaly associated with the labels in the lagbel group.\n
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the label group was created.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the label group was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeLabelRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "Returns the name of the group containing the label.
", + "smithy.api#required": {} + } + }, + "LabelId": { + "target": "com.amazonaws.lookoutequipment#LabelId", + "traits": { + "smithy.api#documentation": "Returns the ID of the label.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeLabelResponse": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the requested label group.
" + } + }, + "LabelGroupArn": { + "target": "com.amazonaws.lookoutequipment#LabelGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the requested label group.
" + } + }, + "LabelId": { + "target": "com.amazonaws.lookoutequipment#LabelId", + "traits": { + "smithy.api#documentation": "The ID of the requested label.
" + } + }, + "StartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start time of the requested label.
" + } + }, + "EndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The end time of the requested label.
" + } + }, + "Rating": { + "target": "com.amazonaws.lookoutequipment#LabelRating", + "traits": { + "smithy.api#documentation": "Indicates whether a labeled event represents an anomaly.
" + } + }, + "FaultCode": { + "target": "com.amazonaws.lookoutequipment#FaultCode", + "traits": { + "smithy.api#documentation": "Indicates the type of anomaly associated with the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + }, + "Notes": { + "target": "com.amazonaws.lookoutequipment#Comments", + "traits": { + "smithy.api#documentation": "Metadata providing additional information about the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + }, + "Equipment": { + "target": "com.amazonaws.lookoutequipment#Equipment", + "traits": { + "smithy.api#documentation": "Indicates that a label pertains to a particular piece of equipment.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the label was created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeModelRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeModelResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a JSON containing the overall information about a specific machine learning\n model, including model name and ARN, dataset, training and evaluation information, status,\n and so on.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model to be described.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeModelResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model being described.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model being described.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset being used by the machine learning being described.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resouce Name (ARN) of the dataset used to create the machine learning model\n being described.
" + } + }, + "Schema": { + "target": "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema", + "traits": { + "smithy.api#documentation": "A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.
" + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information about the labels input, including its S3 location.\n
" + } + }, + "TrainingDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n training data for the machine learning model.
" + } + }, + "TrainingDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of training\n data for the machine learning model.
" + } + }, + "EvaluationDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n evaluation data for the machine learning model.
" + } + }, + "EvaluationDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of\n evaluation data for the machine learning model.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the machine learning model being described.
" + } + }, + "DataPreProcessingConfiguration": { + "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide data that has been\n collected at a 1 second level and you want the system to resample the data at a 1 minute\n rate before training, the TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Specifies the current status of the model being described. Status describes the status\n of the most recent action of the model.
" + } + }, + "TrainingExecutionStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time at which the training of the machine learning model began.
" + } + }, + "TrainingExecutionEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time at which the training of the machine learning model was completed.\n
" + } + }, + "FailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "If the training of the machine learning model failed, this indicates the reason for that\n failure.
" + } + }, + "ModelMetrics": { + "target": "com.amazonaws.lookoutequipment#SynthesizedJsonModelMetrics", + "traits": { + "smithy.api#documentation": "The Model Metrics show an aggregated summary of the model's performance within the\n evaluation time range. This is the JSON content of the metrics created when evaluating the\n model.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the last time the machine learning model was updated. The type of update is\n not specified.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time and date at which the machine learning model was created.
" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#KmsKeyArn", + "traits": { + "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout\n for Equipment.
" + } + }, + "OffCondition": { + "target": "com.amazonaws.lookoutequipment#OffCondition", + "traits": { + "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or\n inference.
" + } + }, + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model version. This field appears if the\n active model version was imported.
" + } + }, + "ImportJobStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the import job was started. This field appears if the active\n model version was imported.
" + } + }, + "ImportJobEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the import job was completed. This field appears if the active\n model version was imported.
" + } + }, + "ActiveModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The name of the model version used by the inference schedular when running a scheduled\n inference execution.
" + } + }, + "ActiveModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version used by the inference scheduler when\n running a scheduled inference execution.
" + } + }, + "ModelVersionActivatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date the active model version was activated.
" + } + }, + "PreviousActiveModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The model version that was set as the active model version prior to the current active\n model version.
" + } + }, + "PreviousActiveModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The ARN of the model version that was set as the active model version prior to the\n current active model version.
" + } + }, + "PreviousModelVersionActivatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the previous active model version was activated.
" + } + }, + "PriorModelMetrics": { + "target": "com.amazonaws.lookoutequipment#SynthesizedJsonModelMetrics", + "traits": { + "smithy.api#documentation": "If the model version was retrained, this field shows a summary of the performance of the\n prior model on the new training range. You can use the information in this JSON-formatted\n object to compare the new model version and the prior model version.
" + } + }, + "LatestScheduledRetrainingFailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "If the model version was generated by retraining and the training failed, this indicates\n the reason for that failure.
" + } + }, + "LatestScheduledRetrainingStatus": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the most recent scheduled retraining run.
" + } + }, + "LatestScheduledRetrainingModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Indicates the most recent model version that was generated by retraining.
" + } + }, + "LatestScheduledRetrainingStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the start time of the most recent scheduled retraining run.
" + } + }, + "LatestScheduledRetrainingAvailableDataInDays": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of days of data used in the most recent scheduled retraining run.\n
" + } + }, + "NextScheduledRetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the date and time that the next scheduled retraining run will start on. Lookout for Equipment\n truncates the time you provide to the nearest UTC day.
" + } + }, + "AccumulatedInferenceDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the start time of the inference data that has been accumulated.
" + } + }, + "AccumulatedInferenceDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the end time of the inference data that has been accumulated.
" + } + }, + "RetrainingSchedulerStatus": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeModelVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves information about a specific machine learning model version.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeModelVersionRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model that this version belongs to.
", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the machine learning model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeModelVersionResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model that this version belongs to.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the parent machine learning model that this version\n belong to.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the machine learning model.
" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "The current status of the model version.
" + } + }, + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", + "traits": { + "smithy.api#documentation": "Indicates whether this model version was created by training or by importing.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset used to train the model version.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used to train the model version.
" + } + }, + "Schema": { + "target": "com.amazonaws.lookoutequipment#InlineDataSchema", + "traits": { + "smithy.api#documentation": "The schema of the data used to train the model version.
" + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "TrainingDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date on which the training data began being gathered. If you imported the version,\n this is the date that the training data in the source version began being gathered.
" + } + }, + "TrainingDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date on which the training data finished being gathered. If you imported the\n version, this is the date that the training data in the source version finished being\n gathered.
" + } + }, + "EvaluationDataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. If you imported\n the version, this is the date that the evaluation set data in the source version began\n being gathered.
" + } + }, + "EvaluationDataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. If you imported\n the version, this is the date that the evaluation set data in the source version finished\n being gathered.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that was used to train the model\n version.
" + } + }, + "DataPreProcessingConfiguration": { + "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration" + }, + "TrainingExecutionStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the training of the version began.
" + } + }, + "TrainingExecutionEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the training of the version completed.
" + } + }, + "FailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "The failure message if the training of the model version failed.
" + } + }, + "ModelMetrics": { + "target": "com.amazonaws.lookoutequipment#ModelMetrics", + "traits": { + "smithy.api#documentation": "Shows an aggregated summary, in JSON format, of the model's performance within the\n evaluation time range. These metrics are created when evaluating the model.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the last time the machine learning model version was updated.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time and date at which the machine learning model version was\n created.
" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The identifier of the KMS key key used to encrypt model version data by\n Amazon Lookout for Equipment.
" + } + }, + "OffCondition": { + "target": "com.amazonaws.lookoutequipment#OffCondition", + "traits": { + "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.
" + } + }, + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "If model version was imported, then this field is the arn of the source model\n version.
" + } + }, + "ImportJobStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the import job began. This field appears if the model version was\n imported.
" + } + }, + "ImportJobEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the import job completed. This field appears if the model version\n was imported.
" + } + }, + "ImportedDataSizeInBytes": { + "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", + "traits": { + "smithy.api#documentation": "The size in bytes of the imported data. This field appears if the model version was\n imported.
" + } + }, + "PriorModelMetrics": { + "target": "com.amazonaws.lookoutequipment#ModelMetrics", + "traits": { + "smithy.api#documentation": "If the model version was retrained, this field shows a summary of the performance of the\n prior model on the new training range. You can use the information in this JSON-formatted\n object to compare the new model version and the prior model version.
" + } + }, + "RetrainingAvailableDataInDays": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of days of data used in the most recent scheduled retraining run.\n
" + } + }, + "AutoPromotionResult": { + "target": "com.amazonaws.lookoutequipment#AutoPromotionResult", + "traits": { + "smithy.api#documentation": "Indicates whether the model version was promoted to be the active version after\n retraining or if there was an error with or cancellation of the retraining.
" + } + }, + "AutoPromotionResultReason": { + "target": "com.amazonaws.lookoutequipment#AutoPromotionResultReason", + "traits": { + "smithy.api#documentation": "Indicates the reason for the AutoPromotionResult. For example, a model\n might not be promoted if its performance was worse than the active version, if there was an\n error during training, or if the retraining scheduler was using MANUAL promote\n mode. The model will be promoted in MANAGED promote mode if the performance is\n better than the previous model.
Provides the details of a resource policy attached to a resource.
" + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that is associated with the resource\n policy.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeResourcePolicyResponse": { + "type": "structure", + "members": { + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.lookoutequipment#Policy", + "traits": { + "smithy.api#documentation": "The resource policy in a JSON-formatted string.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the resource policy was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the resource policy was last modified.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a description of the retraining scheduler, including information such as the\n model name and retraining parameters.
", + "smithy.api#examples": [ + { + "title": "Describes a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "RetrainingStartDate": "2023-11-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D", + "Status": "RUNNING", + "PromoteMode": "MANAGED", + "CreatedAt": "2023-10-01T15:00:00Z", + "UpdatedAt": "2023-10-01T15:00:00Z" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that the retraining scheduler is attached to.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#DescribeRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that the retraining scheduler is attached to.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model that the retraining scheduler is attached to.
" + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "The frequency at which the model retraining is set. This follows the ISO 8601\n guidelines.
" + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "The number of past days of data used for retraining.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "Indicates how the service uses new models. In MANAGED mode, new models are\n used for inference if they have better performance than the current model. In\n MANUAL mode, the new models are not used until they are manually\n activated.
Indicates the time and date at which the retraining scheduler was created.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time and date at which the retraining scheduler was updated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#DuplicateTimestamps": { + "type": "structure", + "members": { + "TotalNumberOfDuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the total number of duplicate timestamps.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information abount duplicate timestamps in the dataset.
" + } + }, + "com.amazonaws.lookoutequipment#Equipment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#EventDurationInSeconds": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.lookoutequipment#FaultCode": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,100}$" + } + }, + "com.amazonaws.lookoutequipment#FaultCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#FaultCode" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.lookoutequipment#FileNameTimestampFormat": { + "type": "string", + "traits": { + "smithy.api#pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" + } + }, + "com.amazonaws.lookoutequipment#Float": { + "type": "float", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lookoutequipment#IamRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.lookoutequipment#IdempotenceToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^\\p{ASCII}{1,256}$" + } + }, + "com.amazonaws.lookoutequipment#ImportDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ImportDatasetRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ImportDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Imports a dataset.
" + } + }, + "com.amazonaws.lookoutequipment#ImportDatasetRequest": { + "type": "structure", + "members": { + "SourceDatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset to import.
", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the machine learning dataset to be created. If the dataset already exists,\n Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled\n with the name of the source dataset.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.\n
" + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "Any tags associated with the dataset to be created.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ImportDatasetResponse": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the created machine learning dataset.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset that was imported.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#DatasetStatus", + "traits": { + "smithy.api#documentation": "The status of the ImportDataset operation.
A unique identifier for the job of importing the dataset.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ImportModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ImportModelVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Imports a model that has been trained successfully.
" + } + }, + "com.amazonaws.lookoutequipment#ImportModelVersionRequest": { + "type": "structure", + "members": { + "SourceModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version to import.
", + "smithy.api#required": {} + } + }, + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name for the machine learning model to be created. If the model already exists,\n Amazon Lookout for Equipment creates a new version. If you do not specify this field, it is filled with the\n name of the source model.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "The name of the dataset for the machine learning model being imported.
", + "smithy.api#required": {} + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source being\n used to create the machine learning model.
" + } + }, + "ServerSideKmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "Provides the identifier of the KMS key key used to encrypt model data by Amazon Lookout for Equipment.\n
" + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "The tags associated with the machine learning model to be created.
" + } + }, + "InferenceDataImportStrategy": { + "target": "com.amazonaws.lookoutequipment#InferenceDataImportStrategy", + "traits": { + "smithy.api#documentation": "Indicates how to import the accumulated inference data when a model version is imported.\n The possible values are as follows:
\nNO_IMPORT – Don't import the data.
\nADD_WHEN_EMPTY – Only import the data from the source model if there is no\n existing data in the target model.
\nOVERWRITE – Import the data from the source model and overwrite the\n existing data in the target model.
\nThe name for the machine learning model.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model being created.
" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version being created.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the model being created.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the ImportModelVersion operation.
The Amazon Resource Name (ARN) of the inference scheduler being used for the inference\n event.
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler being used for the inference events.
" + } + }, + "EventStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the starting time of an inference event.
" + } + }, + "EventEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the ending time of an inference event.
" + } + }, + "Diagnostics": { + "target": "com.amazonaws.lookoutequipment#ModelMetrics", + "traits": { + "smithy.api#documentation": "An array which specifies the names and values of all sensors contributing to an\n inference event.
" + } + }, + "EventDurationInSeconds": { + "target": "com.amazonaws.lookoutequipment#EventDurationInSeconds", + "traits": { + "smithy.api#documentation": "Indicates the size of an inference event in seconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the specific inference event, including start and end time,\n diagnostics information, event duration and so on.
" + } + }, + "com.amazonaws.lookoutequipment#InferenceExecutionStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.lookoutequipment#InferenceExecutionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#InferenceExecutionSummary" + } + }, + "com.amazonaws.lookoutequipment#InferenceExecutionSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model being used for the inference execution.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model used for the inference\n execution.
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler being used for the inference execution.
" + } + }, + "InferenceSchedulerArn": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being used for the inference\n execution.
" + } + }, + "ScheduledStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the start time at which the inference scheduler began the specific inference\n execution.
" + } + }, + "DataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset at which the inference execution began.\n
" + } + }, + "DataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference in the dataset at which the inference execution stopped.\n
" + } + }, + "DataInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference scheduler,\n including delimiter, format, and dataset location.
" + } + }, + "DataOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the output results from for the inference\n execution, including the output Amazon S3 location.\n
" + } + }, + "CustomerResultObject": { + "target": "com.amazonaws.lookoutequipment#S3Object", + "traits": { + "smithy.api#documentation": "The S3 object that the inference execution results were uploaded to.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceExecutionStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the inference execution.
" + } + }, + "FailedReason": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#documentation": "Specifies the reason for failure when an inference execution has failed.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The model version used for the inference execution.
" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Number (ARN) of the model version used for the inference\n execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the specific inference execution, including input and output\n data configuration, inference scheduling information, status, and so on.
" + } + }, + "com.amazonaws.lookoutequipment#InferenceInputConfiguration": { + "type": "structure", + "members": { + "S3InputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceS3InputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n Amazon S3 location of input data.
" + } + }, + "InputTimeZoneOffset": { + "target": "com.amazonaws.lookoutequipment#TimeZoneOffset", + "traits": { + "smithy.api#documentation": "Indicates the difference between your time zone and Coordinated Universal Time\n (UTC).
" + } + }, + "InferenceInputNameConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceInputNameConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n timestamp format and delimiter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n Amazon S3 location of input data..
" + } + }, + "com.amazonaws.lookoutequipment#InferenceInputNameConfiguration": { + "type": "structure", + "members": { + "TimestampFormat": { + "target": "com.amazonaws.lookoutequipment#FileNameTimestampFormat", + "traits": { + "smithy.api#documentation": "The format of the timestamp, whether Epoch time, or standard, with or without hyphens\n (-).
" + } + }, + "ComponentTimestampDelimiter": { + "target": "com.amazonaws.lookoutequipment#ComponentTimestampDelimiter", + "traits": { + "smithy.api#documentation": "Indicates the delimiter character used between items in the data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n timestamp format and delimiter.
" + } + }, + "com.amazonaws.lookoutequipment#InferenceOutputConfiguration": { + "type": "structure", + "members": { + "S3OutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceS3OutputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies configuration information for the output results from for the inference,\n output S3 location.
", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.lookoutequipment#NameOrArn", + "traits": { + "smithy.api#documentation": "The ID number for the KMS key key used to encrypt the inference output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configuration information for the output results from for the inference,\n including KMS key ID and output S3 location.
" + } + }, + "com.amazonaws.lookoutequipment#InferenceS3InputConfiguration": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.lookoutequipment#S3Bucket", + "traits": { + "smithy.api#documentation": "The bucket containing the input dataset for the inference.
", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.lookoutequipment#S3Prefix", + "traits": { + "smithy.api#documentation": "The prefix for the S3 bucket used for the input data for the inference.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n input data S3 location.
" + } + }, + "com.amazonaws.lookoutequipment#InferenceS3OutputConfiguration": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.lookoutequipment#S3Bucket", + "traits": { + "smithy.api#documentation": "The bucket containing the output results from the inference
", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.lookoutequipment#S3Prefix", + "traits": { + "smithy.api#documentation": "The prefix for the S3 bucket used for the output results from the inference.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configuration information for the output results from the inference,\n including output S3 location.
" + } + }, + "com.amazonaws.lookoutequipment#InferenceSchedulerArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:inference-scheduler\\/.+$" + } + }, + "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#InferenceSchedulerName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#InferenceSchedulerStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "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.lookoutequipment#InferenceSchedulerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerSummary" + } + }, + "com.amazonaws.lookoutequipment#InferenceSchedulerSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model used for the inference scheduler.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model used by the inference\n scheduler.
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler.
" + } + }, + "InferenceSchedulerArn": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the inference scheduler.
" + } + }, + "DataDelayOffsetInMinutes": { + "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", + "traits": { + "smithy.api#documentation": "A period of time (in minutes) by which inference on the data is delayed after the data\n starts. For instance, if an offset delay time of five minutes was selected, inference will\n not begin on the data until the first data measurement after the five minute mark. For\n example, if five minutes is selected, the inference scheduler will wake up at the\n configured frequency with the additional five minute delay time to check the customer S3\n bucket. The customer can upload data at the same frequency and they don't need to stop and\n restart the scheduler when uploading new data.
" + } + }, + "DataUploadFrequency": { + "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", + "traits": { + "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. This value is the\n length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout\n for Equipment will upload the real-time data to the source bucket once every 5 minutes.\n This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your\n data. In this example, it starts once every 5 minutes.
" + } + }, + "LatestInferenceResult": { + "target": "com.amazonaws.lookoutequipment#LatestInferenceResult", + "traits": { + "smithy.api#documentation": "Indicates whether the latest execution for the inference scheduler was Anomalous\n (anomalous events found) or Normal (no anomalous events found).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the specific inference scheduler, including data delay\n offset, model name and ARN, status, and so on.
" + } + }, + "com.amazonaws.lookoutequipment#IngestedFilesSummary": { + "type": "structure", + "members": { + "TotalNumberOfFiles": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the total number of files that were submitted for ingestion.
", + "smithy.api#required": {} + } + }, + "IngestedNumberOfFiles": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of files that were successfully ingested.
", + "smithy.api#required": {} + } + }, + "DiscardedFiles": { + "target": "com.amazonaws.lookoutequipment#ListOfDiscardedFiles", + "traits": { + "smithy.api#documentation": "Indicates the number of files that were discarded. A file could be discarded because its\n format is invalid (for example, a jpg or pdf) or not readable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Gives statistics about how many files have been ingested, and which files have not been\n ingested, for a particular ingestion job.
" + } + }, + "com.amazonaws.lookoutequipment#IngestionInputConfiguration": { + "type": "structure", + "members": { + "S3InputConfiguration": { + "target": "com.amazonaws.lookoutequipment#IngestionS3InputConfiguration", + "traits": { + "smithy.api#documentation": "The location information for the S3 bucket used for input data for the data ingestion.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies configuration information for the input data for the data ingestion job,\n including input data S3 location.
" + } + }, + "com.amazonaws.lookoutequipment#IngestionJobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[A-Fa-f0-9]{0,32}$" + } + }, + "com.amazonaws.lookoutequipment#IngestionJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.lookoutequipment#IngestionS3InputConfiguration": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.lookoutequipment#S3Bucket", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket used for the input data for the data ingestion.
", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.lookoutequipment#S3Prefix", + "traits": { + "smithy.api#documentation": "The prefix for the S3 location being used for the input data for the data ingestion.\n
" + } + }, + "KeyPattern": { + "target": "com.amazonaws.lookoutequipment#KeyPattern", + "traits": { + "smithy.api#documentation": "The pattern for matching the Amazon S3 files that will be used for ingestion.\n If the schema was created previously without any KeyPattern, then the default KeyPattern\n {prefix}/{component_name}/* is used to download files from Amazon S3 according to\n the schema. This field is required when ingestion is being done for the first time.
\nValid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* |\n {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore,\n hyphen)
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies S3 configuration information for the input data for the data ingestion job.\n
" + } + }, + "com.amazonaws.lookoutequipment#InlineDataSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000000 + } + } + }, + "com.amazonaws.lookoutequipment#InsufficientSensorData": { + "type": "structure", + "members": { + "MissingCompleteSensorData": { + "target": "com.amazonaws.lookoutequipment#MissingCompleteSensorData", + "traits": { + "smithy.api#documentation": "Parameter that describes the total number of sensors that have data completely missing\n for it.
", + "smithy.api#required": {} + } + }, + "SensorsWithShortDateRange": { + "target": "com.amazonaws.lookoutequipment#SensorsWithShortDateRange", + "traits": { + "smithy.api#documentation": "Parameter that describes the total number of sensors that have a short date range of\n less than 90 days of data overall.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises aggregated information on sensors having insufficient data.\n
" + } + }, + "com.amazonaws.lookoutequipment#Integer": { + "type": "integer" + }, + "com.amazonaws.lookoutequipment#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Processing of the request has failed because of an unknown error, exception or failure.\n
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.lookoutequipment#InvalidSensorData": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of sensors that have at least some invalid values.
", + "smithy.api#required": {} + } + }, + "TotalNumberOfInvalidValues": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the total number of invalid values across all the sensors.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises aggregated information on sensors having insufficient data.\n
" + } + }, + "com.amazonaws.lookoutequipment#KeyPattern": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.lookoutequipment#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[a-z\\-]*:kms:[a-z0-9\\-]*:\\d{12}:[\\w\\-\\/]+$" + } + }, + "com.amazonaws.lookoutequipment#LabelGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:label-group\\/.+$" + } + }, + "com.amazonaws.lookoutequipment#LabelGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#LabelGroupSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#LabelGroupSummary" + } + }, + "com.amazonaws.lookoutequipment#LabelGroupSummary": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group.
" + } + }, + "LabelGroupArn": { + "target": "com.amazonaws.lookoutequipment#LabelGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the label group was created.
" + } + }, + "UpdatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the label group was updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the label group.
" + } + }, + "com.amazonaws.lookoutequipment#LabelId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + }, + "smithy.api#pattern": "^[A-Fa-f0-9]{0,32}$" + } + }, + "com.amazonaws.lookoutequipment#LabelRating": { + "type": "enum", + "members": { + "ANOMALY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALY" + } + }, + "NO_ANOMALY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ANOMALY" + } + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + } + } + }, + "com.amazonaws.lookoutequipment#LabelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#LabelSummary" + } + }, + "com.amazonaws.lookoutequipment#LabelSummary": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group.
" + } + }, + "LabelId": { + "target": "com.amazonaws.lookoutequipment#LabelId", + "traits": { + "smithy.api#documentation": "The ID of the label.
" + } + }, + "LabelGroupArn": { + "target": "com.amazonaws.lookoutequipment#LabelGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the label group.
" + } + }, + "StartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp indicating the start of the label.
" + } + }, + "EndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp indicating the end of the label.
" + } + }, + "Rating": { + "target": "com.amazonaws.lookoutequipment#LabelRating", + "traits": { + "smithy.api#documentation": "Indicates whether a labeled event represents an anomaly.
" + } + }, + "FaultCode": { + "target": "com.amazonaws.lookoutequipment#FaultCode", + "traits": { + "smithy.api#documentation": "Indicates the type of anomaly associated with the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + }, + "Equipment": { + "target": "com.amazonaws.lookoutequipment#Equipment", + "traits": { + "smithy.api#documentation": "Indicates that a label pertains to a particular piece of equipment.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the label was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the label.
" + } + }, + "com.amazonaws.lookoutequipment#LabelsInputConfiguration": { + "type": "structure", + "members": { + "S3InputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsS3InputConfiguration", + "traits": { + "smithy.api#documentation": "Contains location information for the S3 location being used for label data.
" + } + }, + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group to be used for label data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the configuration information for the S3 location being used to hold label\n data.
" + } + }, + "com.amazonaws.lookoutequipment#LabelsS3InputConfiguration": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.lookoutequipment#S3Bucket", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket holding the label data.
", + "smithy.api#required": {} + } + }, + "Prefix": { + "target": "com.amazonaws.lookoutequipment#S3Prefix", + "traits": { + "smithy.api#documentation": "The prefix for the S3 bucket used for the label data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location information (prefix and bucket name) for the s3 location being used for\n label data.
" + } + }, + "com.amazonaws.lookoutequipment#LargeTimestampGaps": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "Indicates whether there is a potential data issue related to large gaps in timestamps.\n
", + "smithy.api#required": {} + } + }, + "NumberOfLargeTimestampGaps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of large timestamp gaps, if there are any.
" + } + }, + "MaxTimestampGapInDays": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the size of the largest timestamp gap, in days.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information on large gaps between consecutive timestamps in data.\n
" + } + }, + "com.amazonaws.lookoutequipment#LatestInferenceResult": { + "type": "enum", + "members": { + "ANOMALOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANOMALOUS" + } + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + } + } + }, + "com.amazonaws.lookoutequipment#ListDataIngestionJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListDataIngestionJobsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListDataIngestionJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location\n of the input data, status, and so on.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListDataIngestionJobsRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset being used for the data ingestion job.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of data ingestion\n jobs.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of data ingestion jobs to list.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the data ingestion job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListDataIngestionJobsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of data ingestion\n jobs.
" + } + }, + "DataIngestionJobSummaries": { + "target": "com.amazonaws.lookoutequipment#DataIngestionJobSummaries", + "traits": { + "smithy.api#documentation": "Specifies information about the specific data ingestion job, including dataset name and\n status.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all datasets currently available in your account, filtering on the dataset name.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListDatasetsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of datasets.\n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of datasets to list.
" + } + }, + "DatasetNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The beginning of the name of the datasets to be listed.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListDatasetsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of datasets.\n
" + } + }, + "DatasetSummaries": { + "target": "com.amazonaws.lookoutequipment#DatasetSummaries", + "traits": { + "smithy.api#documentation": "Provides information about the specified dataset, including creation time, dataset ARN,\n and status.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListInferenceEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListInferenceEventsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListInferenceEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all inference events that have been found for the specified inference scheduler.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListInferenceEventsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n events.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of inference events to list.
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler for the inference events listed.
", + "smithy.api#required": {} + } + }, + "IntervalStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Lookout for Equipment will return all the inference events with an end time equal to or greater than\n the start time given.
", + "smithy.api#required": {} + } + }, + "IntervalEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Returns all the inference events with an end start time equal to or greater than less\n than the end time given.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListInferenceEventsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n executions.
" + } + }, + "InferenceEventSummaries": { + "target": "com.amazonaws.lookoutequipment#InferenceEventSummaries", + "traits": { + "smithy.api#documentation": "Provides an array of information about the individual inference events returned from the\n ListInferenceEvents operation, including scheduler used, event start time,\n event end time, diagnostics, and so on.
Lists all inference executions that have been performed by the specified inference\n scheduler.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListInferenceExecutionsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n executions.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of inference executions to list.
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler for the inference execution listed.
", + "smithy.api#required": {} + } + }, + "DataStartTimeAfter": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time reference in the inferenced dataset after which Amazon Lookout for Equipment started the inference\n execution.
" + } + }, + "DataEndTimeBefore": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time reference in the inferenced dataset before which Amazon Lookout for Equipment stopped the\n inference execution.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceExecutionStatus", + "traits": { + "smithy.api#documentation": "The status of the inference execution.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListInferenceExecutionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n executions.
" + } + }, + "InferenceExecutionSummaries": { + "target": "com.amazonaws.lookoutequipment#InferenceExecutionSummaries", + "traits": { + "smithy.api#documentation": "Provides an array of information about the individual inference executions returned from\n the ListInferenceExecutions operation, including model used, inference\n scheduler, data configuration, and so on.
Retrieves a list of all inference schedulers currently available for your account.\n
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListInferenceSchedulersRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n schedulers.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of inference schedulers to list.
" + } + }, + "InferenceSchedulerNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The beginning of the name of the inference schedulers to be listed.
" + } + }, + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model used by the inference scheduler to be listed.\n
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "Specifies the current status of the inference schedulers.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListInferenceSchedulersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n schedulers.
" + } + }, + "InferenceSchedulerSummaries": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerSummaries", + "traits": { + "smithy.api#documentation": "Provides information about the specified inference scheduler, including data upload\n frequency, model name and ARN, and status.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListLabelGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListLabelGroupsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListLabelGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of the label groups.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListLabelGroupsRequest": { + "type": "structure", + "members": { + "LabelGroupNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The beginning of the name of the label groups to be listed.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of label groups.\n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of label groups to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListLabelGroupsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of label groups.\n
" + } + }, + "LabelGroupSummaries": { + "target": "com.amazonaws.lookoutequipment#LabelGroupSummaries", + "traits": { + "smithy.api#documentation": "A summary of the label groups.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListLabels": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListLabelsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListLabelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of labels.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListLabelsRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "Retruns the name of the label group.
", + "smithy.api#required": {} + } + }, + "IntervalStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Returns all the labels with a end time equal to or later than the start time given.\n
" + } + }, + "IntervalEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Returns all labels with a start time earlier than the end time given.
" + } + }, + "FaultCode": { + "target": "com.amazonaws.lookoutequipment#FaultCode", + "traits": { + "smithy.api#documentation": "Returns labels with a particular fault code.
" + } + }, + "Equipment": { + "target": "com.amazonaws.lookoutequipment#Equipment", + "traits": { + "smithy.api#documentation": "Lists the labels that pertain to a particular piece of equipment.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of label groups.\n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of labels to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListLabelsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of datasets.\n
" + } + }, + "LabelSummaries": { + "target": "com.amazonaws.lookoutequipment#LabelSummaries", + "traits": { + "smithy.api#documentation": "A summary of the items in the label group.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListModelVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListModelVersionsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListModelVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Generates a list of all model versions for a given model, including the model version,\n model version ARN, and status. To list a subset of versions, use the\n MaxModelVersion and MinModelVersion fields.
Then name of the machine learning model for which the model versions are to be\n listed.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results exceeds the limit that the response can display, the\n response returns an opaque pagination token indicating where to continue the listing of\n machine learning model versions. Use this token in the NextToken field in the\n request to list the next page of results.
Specifies the maximum number of machine learning model versions to list.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "Filter the results based on the current status of the model version.
" + } + }, + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", + "traits": { + "smithy.api#documentation": "Filter the results based on the way the model version was generated.
" + } + }, + "CreatedAtEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Filter results to return all the model versions created before this time.
" + } + }, + "CreatedAtStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Filter results to return all the model versions created after this time.
" + } + }, + "MaxModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Specifies the highest version of the model to return in the list.
" + } + }, + "MinModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Specifies the lowest version of the model to return in the list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListModelVersionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "If the total number of results exceeds the limit that the response can display, the\n response returns an opaque pagination token indicating where to continue the listing of\n machine learning model versions. Use this token in the NextToken field in the\n request to list the next page of results.
Provides information on the specified model version, including the created time, model\n and dataset ARNs, and status.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListModels": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListModelsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListModelsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Generates a list of all models in the account, including model name and ARN, dataset,\n and status.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListModelsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of machine learning\n models.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of machine learning models to list.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelStatus", + "traits": { + "smithy.api#documentation": "The status of the machine learning model.
" + } + }, + "ModelNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The beginning of the name of the machine learning models being listed.
" + } + }, + "DatasetNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The beginning of the name of the dataset of the machine learning models to be listed.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListModelsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of machine learning\n models.
" + } + }, + "ModelSummaries": { + "target": "com.amazonaws.lookoutequipment#ModelSummaries", + "traits": { + "smithy.api#documentation": "Provides information on the specified model, including created time, model and dataset\n ARNs, and status.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListOfDiscardedFiles": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#S3Object" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulers": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulersRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListRetrainingSchedulersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all retraining schedulers in your account, filtering by model name prefix and\n status.
", + "smithy.api#examples": [ + { + "title": "Listing retraining schedulers", + "documentation": "", + "input": { + "MaxResults": 50 + }, + "output": { + "RetrainingSchedulerSummaries": [ + { + "ModelName": "sample-model-1", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "RUNNING", + "RetrainingStartDate": "2023-06-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P180D" + }, + { + "ModelName": "sample-model-2", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Status": "RUNNING", + "RetrainingStartDate": "2023-08-15T00:00:00Z", + "RetrainingFrequency": "P30D", + "LookbackWindow": "P180D" + }, + { + "ModelName": "sample-model-3", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "Status": "STOPPED", + "RetrainingStartDate": "2023-09-01T00:00:00Z", + "RetrainingFrequency": "P1M", + "LookbackWindow": "P360D" + } + ] + } + } + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulersRequest": { + "type": "structure", + "members": { + "ModelNameBeginsWith": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "Specify this field to only list retraining schedulers whose machine learning models\n begin with the value you specify.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "Specify this field to only list retraining schedulers whose status matches the value you\n specify.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "If the number of results exceeds the maximum, a pagination token is returned. Use the\n token in the request to show the next page of retraining schedulers.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of retraining schedulers to list.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListRetrainingSchedulersResponse": { + "type": "structure", + "members": { + "RetrainingSchedulerSummaries": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerSummaries", + "traits": { + "smithy.api#documentation": "Provides information on the specified retraining scheduler, including the model name,\n model ARN, status, and start date.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "If the number of results exceeds the maximum, this pagination token is returned. Use\n this token in the request to show the next page of retraining schedulers.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListSensorStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListSensorStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists statistics about the data collected for each of the sensors that have been\n successfully ingested in the particular dataset. Can also be used to retreive Sensor\n Statistics for a previous ingestion job.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutequipment#ListSensorStatisticsRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset associated with the list of Sensor Statistics.
", + "smithy.api#required": {} + } + }, + "IngestionJobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { + "smithy.api#documentation": "The ingestion job id associated with the list of Sensor Statistics. To get sensor\n statistics for a particular ingestion job id, both dataset name and ingestion job id must\n be submitted as inputs.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.lookoutequipment#MaxResults", + "traits": { + "smithy.api#documentation": "Specifies the maximum number of sensors for which to retrieve statistics.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of sensor\n statistics.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse": { + "type": "structure", + "members": { + "SensorStatisticsSummaries": { + "target": "com.amazonaws.lookoutequipment#SensorStatisticsSummaries", + "traits": { + "smithy.api#documentation": "Provides ingestion-based statistics regarding the specified sensor with respect to\n various validation types, such as whether data exists, the number and percentage of missing\n values, and the number and percentage of duplicate timestamps.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutequipment#NextToken", + "traits": { + "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of sensor\n statistics.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the tags for a specified resource, including key and value.
" + } + }, + "com.amazonaws.lookoutequipment#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#AmazonResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is\n the focus of the ListTagsForResource operation.
Any tags associated with the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#LookbackWindow": { + "type": "string", + "traits": { + "smithy.api#pattern": "^P180D$|^P360D$|^P540D$|^P720D$" + } + }, + "com.amazonaws.lookoutequipment#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.lookoutequipment#MissingCompleteSensorData": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of sensors that have data missing completely.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information on sensors that have sensor data completely missing.\n
" + } + }, + "com.amazonaws.lookoutequipment#MissingSensorData": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of sensors that have atleast some data missing.
", + "smithy.api#required": {} + } + }, + "TotalNumberOfMissingValues": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the total number of missing values across all the sensors.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises aggregated information on sensors having missing data.
" + } + }, + "com.amazonaws.lookoutequipment#ModelArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+$" + } + }, + "com.amazonaws.lookoutequipment#ModelMetrics": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50000 + } + } + }, + "com.amazonaws.lookoutequipment#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#ModelPromoteMode": { + "type": "enum", + "members": { + "MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANAGED" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.lookoutequipment#ModelStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.lookoutequipment#ModelSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#ModelSummary" + } + }, + "com.amazonaws.lookoutequipment#ModelSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset being used for the machine learning model.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.lookoutequipment#DatasetArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used to create the model.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the machine learning model.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the specific model was created.
" + } + }, + "ActiveModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The model version that the inference scheduler uses to run an inference\n execution.
" + } + }, + "ActiveModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version that is set as active. The active\n model version is the model version that the inference scheduler uses to run an inference\n execution.
" + } + }, + "LatestScheduledRetrainingStatus": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the most recent scheduled retraining run.
" + } + }, + "LatestScheduledRetrainingModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "Indicates the most recent model version that was generated by retraining.
" + } + }, + "LatestScheduledRetrainingStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the start time of the most recent scheduled retraining run.
" + } + }, + "NextScheduledRetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates\n the time you provide to the nearest UTC day.
" + } + }, + "RetrainingSchedulerStatus": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the specified machine learning model, including dataset and\n model names and ARNs, as well as status.
" + } + }, + "com.amazonaws.lookoutequipment#ModelVersion": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.lookoutequipment#ModelVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+\\/.+\\/model-version\\/[0-9]{1,}$" + } + }, + "com.amazonaws.lookoutequipment#ModelVersionSourceType": { + "type": "enum", + "members": { + "TRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRAINING" + } + }, + "RETRAINING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRAINING" + } + }, + "IMPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT" + } + } + } + }, + "com.amazonaws.lookoutequipment#ModelVersionStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESS" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "IMPORT_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMPORT_IN_PROGRESS" + } + }, + "CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELED" + } + } + } + }, + "com.amazonaws.lookoutequipment#ModelVersionSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSummary" + } + }, + "com.amazonaws.lookoutequipment#ModelVersionSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that this model version is a version of.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model that this model version is a version\n of.
" + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the model.
" + } + }, + "ModelVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The time when this model version was created.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", + "traits": { + "smithy.api#documentation": "The current status of the model version.
" + } + }, + "SourceType": { + "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", + "traits": { + "smithy.api#documentation": "Indicates how this model version was generated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the specific model version.
" + } + }, + "com.amazonaws.lookoutequipment#MonotonicValues": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "Indicates whether there is a potential data issue related to having monotonic values.\n
", + "smithy.api#required": {} + } + }, + "Monotonicity": { + "target": "com.amazonaws.lookoutequipment#Monotonicity", + "traits": { + "smithy.api#documentation": "Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information on monotonic values in the data.
" + } + }, + "com.amazonaws.lookoutequipment#Monotonicity": { + "type": "enum", + "members": { + "DECREASING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECREASING" + } + }, + "INCREASING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREASING" + } + }, + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" + } + } + } + }, + "com.amazonaws.lookoutequipment#MultipleOperatingModes": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", + "traits": { + "smithy.api#documentation": "Indicates whether there is a potential data issue related to having multiple operating\n modes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information on operating modes in data.
" + } + }, + "com.amazonaws.lookoutequipment#NameOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" + } + }, + "com.amazonaws.lookoutequipment#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": "^\\p{ASCII}{0,8192}$" + } + }, + "com.amazonaws.lookoutequipment#OffCondition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.lookoutequipment#Policy": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.lookoutequipment#PolicyRevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^[0-9A-Fa-f]+$" + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicyRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#PutResourcePolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a resource control policy for a given resource.
" + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicyRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the policy is being\n created.
", + "smithy.api#required": {} + } + }, + "ResourcePolicy": { + "target": "com.amazonaws.lookoutequipment#Policy", + "traits": { + "smithy.api#documentation": "The JSON-formatted resource policy to create.
", + "smithy.api#required": {} + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token,\n Amazon Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#PutResourcePolicyResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the policy was created.
" + } + }, + "PolicyRevisionId": { + "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", + "traits": { + "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:.+$" + } + }, + "com.amazonaws.lookoutequipment#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The resource requested could not be found. Verify the resource ID and retry your\n request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.lookoutequipment#RetrainingFrequency": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + }, + "smithy.api#pattern": "^P(\\dY)?(\\d{1,2}M)?(\\d{1,3}D)?$" + } + }, + "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "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.lookoutequipment#RetrainingSchedulerSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerSummary" + } + }, + "com.amazonaws.lookoutequipment#RetrainingSchedulerSummary": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model that the retraining scheduler is attached to.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model that the retraining scheduler is attached to.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "The frequency at which the model retraining is set. This follows the ISO 8601\n guidelines.
" + } + }, + "LookbackWindow": { + "target": "com.amazonaws.lookoutequipment#LookbackWindow", + "traits": { + "smithy.api#documentation": "The number of past days of data used for retraining.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the specified retraining scheduler, including model name,\n status, start date, frequency, and lookback window.
" + } + }, + "com.amazonaws.lookoutequipment#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.lookoutequipment#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,1024}[^/]$" + } + }, + "com.amazonaws.lookoutequipment#S3Object": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.lookoutequipment#S3Bucket", + "traits": { + "smithy.api#documentation": "The name of the specific S3 bucket.
", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.lookoutequipment#S3Key", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object.\n Without this key, data in the bucket is not accessible.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an S3 bucket.
" + } + }, + "com.amazonaws.lookoutequipment#S3Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^(^$)|([\\u0009\\u000A\\u000D\\u0020-\\u00FF]{1,1023}/$)$" + } + }, + "com.amazonaws.lookoutequipment#SensorName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z:#$.\\-_]{1,200}$" + } + }, + "com.amazonaws.lookoutequipment#SensorStatisticsSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#SensorStatisticsSummary" + } + }, + "com.amazonaws.lookoutequipment#SensorStatisticsSummary": { + "type": "structure", + "members": { + "ComponentName": { + "target": "com.amazonaws.lookoutequipment#ComponentName", + "traits": { + "smithy.api#documentation": "Name of the component to which the particular sensor belongs for which the statistics\n belong to.
" + } + }, + "SensorName": { + "target": "com.amazonaws.lookoutequipment#SensorName", + "traits": { + "smithy.api#documentation": "Name of the sensor that the statistics belong to.
" + } + }, + "DataExists": { + "target": "com.amazonaws.lookoutequipment#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Parameter that indicates whether data exists for the sensor that the statistics belong\n to.
" + } + }, + "MissingValues": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "Parameter that describes the total number of, and percentage of, values that are\n missing for the sensor that the statistics belong to.
" + } + }, + "InvalidValues": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "Parameter that describes the total number of, and percentage of, values that are\n invalid for the sensor that the statistics belong to.
" + } + }, + "InvalidDateEntries": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "Parameter that describes the total number of invalid date entries associated with the\n sensor that the statistics belong to.
" + } + }, + "DuplicateTimestamps": { + "target": "com.amazonaws.lookoutequipment#CountPercent", + "traits": { + "smithy.api#documentation": "Parameter that describes the total number of duplicate timestamp records associated\n with the sensor that the statistics belong to.
" + } + }, + "CategoricalValues": { + "target": "com.amazonaws.lookoutequipment#CategoricalValues", + "traits": { + "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n is categorical.
" + } + }, + "MultipleOperatingModes": { + "target": "com.amazonaws.lookoutequipment#MultipleOperatingModes", + "traits": { + "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n has more than one operating mode.
" + } + }, + "LargeTimestampGaps": { + "target": "com.amazonaws.lookoutequipment#LargeTimestampGaps", + "traits": { + "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n contains one or more large gaps between consecutive timestamps.
" + } + }, + "MonotonicValues": { + "target": "com.amazonaws.lookoutequipment#MonotonicValues", + "traits": { + "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n is mostly monotonic.
" + } + }, + "DataStartTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference to indicate the beginning of valid data associated with\n the sensor that the statistics belong to.
" + } + }, + "DataEndTime": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "Indicates the time reference to indicate the end of valid data associated with the\n sensor that the statistics belong to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of ingestion statistics like whether data exists, number of missing values,\n number of invalid values and so on related to the particular sensor.
" + } + }, + "com.amazonaws.lookoutequipment#SensorsWithShortDateRange": { + "type": "structure", + "members": { + "AffectedSensorCount": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the number of sensors that have less than 90 days of data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information on sensors that have shorter date range.
" + } + }, + "com.amazonaws.lookoutequipment#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Resource limitations have been exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.lookoutequipment#StartDataIngestionJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StartDataIngestionJobRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StartDataIngestionJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.
" + } + }, + "com.amazonaws.lookoutequipment#StartDataIngestionJobRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", + "traits": { + "smithy.api#documentation": "The name of the dataset being used by the data ingestion job.
", + "smithy.api#required": {} + } + }, + "IngestionInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies information for the input data for the data ingestion job, including dataset\n S3 location.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the data ingestion job.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.lookoutequipment#IdempotenceToken", + "traits": { + "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StartDataIngestionJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.lookoutequipment#IngestionJobId", + "traits": { + "smithy.api#documentation": "Indicates the job ID of the data ingestion job.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the StartDataIngestionJob operation.
Starts an inference scheduler.
" + } + }, + "com.amazonaws.lookoutequipment#StartInferenceSchedulerRequest": { + "type": "structure", + "members": { + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler to be started.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StartInferenceSchedulerResponse": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model being used by the inference\n scheduler.
" + } + }, + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model being used by the inference scheduler.
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler being started.
" + } + }, + "InferenceSchedulerArn": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being started.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the inference scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#StartRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StartRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StartRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a retraining scheduler.
", + "smithy.api#examples": [ + { + "title": "Starts a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "PENDING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#StartRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler you want to start.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StartRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler is being started.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model whose retraining scheduler is being started.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { + "type": "enum", + "members": { + "POTENTIAL_ISSUE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POTENTIAL_ISSUE_DETECTED" + } + }, + "NO_ISSUE_DETECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ISSUE_DETECTED" + } + } + } + }, + "com.amazonaws.lookoutequipment#StopInferenceScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StopInferenceSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StopInferenceSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops an inference scheduler.
" + } + }, + "com.amazonaws.lookoutequipment#StopInferenceSchedulerRequest": { + "type": "structure", + "members": { + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler to be stopped.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StopInferenceSchedulerResponse": { + "type": "structure", + "members": { + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model used by the inference\n scheduler being stopped.
" + } + }, + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model used by the inference scheduler being stopped.\n
" + } + }, + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler being stopped.
" + } + }, + "InferenceSchedulerArn": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference schedule being stopped.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the inference scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#StopRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#StopRetrainingSchedulerRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#StopRetrainingSchedulerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops a retraining scheduler.
", + "smithy.api#examples": [ + { + "title": "Stops a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model" + }, + "output": { + "ModelName": "sample-model", + "ModelArn": "arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Status": "STOPPING" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#StopRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler you want to stop.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#StopRetrainingSchedulerResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler is being stopped.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The ARN of the model whose retraining scheduler is being stopped.
" + } + }, + "Status": { + "target": "com.amazonaws.lookoutequipment#RetrainingSchedulerStatus", + "traits": { + "smithy.api#documentation": "The status of the retraining scheduler.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000000 + }, + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.lookoutequipment#SynthesizedJsonModelMetrics": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50000 + }, + "smithy.api#mediaType": "application/json" + } + }, + "com.amazonaws.lookoutequipment#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.lookoutequipment#TagKey", + "traits": { + "smithy.api#documentation": "The key for the specified tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.lookoutequipment#TagValue", + "traits": { + "smithy.api#documentation": "The value for the specified tag.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A tag is a key-value pair that can be added to a resource as metadata.
" + } + }, + "com.amazonaws.lookoutequipment#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + } + }, + "com.amazonaws.lookoutequipment#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.lookoutequipment#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutequipment#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.lookoutequipment#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a given tag to a resource in your account. A tag is a key-value pair which\n can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your\n resources as well as helping you to search and filter by tag. Multiple tags can be added to\n a resource, either when you create it, or later. Up to 50 tags can be associated with each\n resource.
" + } + }, + "com.amazonaws.lookoutequipment#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#AmazonResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specific resource to which the tag should be\n associated.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.lookoutequipment#TagList", + "traits": { + "smithy.api#documentation": "The tag or tags to be associated with a specific resource. Both the tag key and value\n are specified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" + } + }, + "com.amazonaws.lookoutequipment#TargetSamplingRate": { + "type": "enum", + "members": { + "PT1S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1S" + } + }, + "PT5S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5S" + } + }, + "PT10S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10S" + } + }, + "PT15S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15S" + } + }, + "PT30S": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30S" + } + }, + "PT1M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1M" + } + }, + "PT5M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT5M" + } + }, + "PT10M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT10M" + } + }, + "PT15M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT15M" + } + }, + "PT30M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT30M" + } + }, + "PT1H": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PT1H" + } + } + } + }, + "com.amazonaws.lookoutequipment#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lookoutequipment#BoundedLengthString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.lookoutequipment#TimeZoneOffset": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(\\+|\\-)[0-9]{2}\\:[0-9]{2}$" + } + }, + "com.amazonaws.lookoutequipment#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.lookoutequipment#UnsupportedTimestamps": { + "type": "structure", + "members": { + "TotalNumberOfUnsupportedTimestamps": { + "target": "com.amazonaws.lookoutequipment#Integer", + "traits": { + "smithy.api#documentation": "Indicates the total number of unsupported timestamps across the ingested data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Entity that comprises information abount unsupported timestamps in the dataset.
" + } + }, + "com.amazonaws.lookoutequipment#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes a specific tag from a given resource. The tag is specified by its key.
" + } + }, + "com.amazonaws.lookoutequipment#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.lookoutequipment#AmazonResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.\n
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.lookoutequipment#TagKeyList", + "traits": { + "smithy.api#documentation": "Specifies the key of the tag to be removed from a specified resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest" + }, + "output": { + "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Sets the active model version for a given machine learning model.
" + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model for which the active model version is being\n set.
", + "smithy.api#required": {} + } + }, + "ModelVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version of the machine learning model for which the active model version is being\n set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the machine learning model for which the active model version was\n set.
" + } + }, + "ModelArn": { + "target": "com.amazonaws.lookoutequipment#ModelArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model for which the active model\n version was set.
" + } + }, + "CurrentActiveVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The version that is currently active of the machine learning model for which the active\n model version was set.
" + } + }, + "PreviousActiveVersion": { + "target": "com.amazonaws.lookoutequipment#ModelVersion", + "traits": { + "smithy.api#documentation": "The previous version that was active of the machine learning model for which the active\n model version was set.
" + } + }, + "CurrentActiveVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that is the current\n active model version.
" + } + }, + "PreviousActiveVersionArn": { + "target": "com.amazonaws.lookoutequipment#ModelVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that was the\n previous active model version.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateInferenceScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateInferenceSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an inference scheduler.
" + } + }, + "com.amazonaws.lookoutequipment#UpdateInferenceSchedulerRequest": { + "type": "structure", + "members": { + "InferenceSchedulerName": { + "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", + "traits": { + "smithy.api#documentation": "The name of the inference scheduler to be updated.
", + "smithy.api#required": {} + } + }, + "DataDelayOffsetInMinutes": { + "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", + "traits": { + "smithy.api#documentation": "A period of time (in minutes) by which inference on the data is delayed after the data\n starts. For instance, if you select an offset delay time of five minutes, inference will\n not begin on the data until the first data measurement after the five minute mark. For\n example, if five minutes is selected, the inference scheduler will wake up at the\n configured frequency with the additional five minute delay time to check the customer S3\n bucket. The customer can upload data at the same frequency and they don't need to stop and\n restart the scheduler when uploading new data.
" + } + }, + "DataUploadFrequency": { + "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", + "traits": { + "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon\n Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on\n your data. In this example, it starts once every 5 minutes.
" + } + }, + "DataInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies information for the input data for the inference scheduler, including\n delimiter, format, and dataset location.
" + } + }, + "DataOutputConfiguration": { + "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", + "traits": { + "smithy.api#documentation": "Specifies information for the output results from the inference scheduler, including\n the output S3 location.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the inference scheduler.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateLabelGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the label group.
" + } + }, + "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest": { + "type": "structure", + "members": { + "LabelGroupName": { + "target": "com.amazonaws.lookoutequipment#LabelGroupName", + "traits": { + "smithy.api#documentation": "The name of the label group to be updated.
", + "smithy.api#required": {} + } + }, + "FaultCodes": { + "target": "com.amazonaws.lookoutequipment#FaultCodes", + "traits": { + "smithy.api#documentation": "Updates the code indicating the type of anomaly associated with the label.
\nData in this field will be retained for service usage. Follow best practices for the\n security of your data.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateModel": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateModelRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a model in the account.
", + "smithy.api#examples": [ + { + "title": "Updates a model", + "documentation": "", + "input": { + "ModelName": "sample-model", + "LabelsInputConfiguration": { + "LabelGroupName": "sample-label-group" + } + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#UpdateModelRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model to update.
", + "smithy.api#required": {} + } + }, + "LabelsInputConfiguration": { + "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" + }, + "RoleArn": { + "target": "com.amazonaws.lookoutequipment#IamRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the model to update.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lookoutequipment#UpdateRetrainingScheduler": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutequipment#UpdateRetrainingSchedulerRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutequipment#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutequipment#ConflictException" + }, + { + "target": "com.amazonaws.lookoutequipment#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutequipment#ThrottlingException" + }, + { + "target": "com.amazonaws.lookoutequipment#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a retraining scheduler.
", + "smithy.api#examples": [ + { + "title": "Updates a retraining scheduler", + "documentation": "", + "input": { + "ModelName": "sample-model", + "RetrainingStartDate": "2024-01-01T00:00:00Z", + "RetrainingFrequency": "P1Y" + } + } + ] + } + }, + "com.amazonaws.lookoutequipment#UpdateRetrainingSchedulerRequest": { + "type": "structure", + "members": { + "ModelName": { + "target": "com.amazonaws.lookoutequipment#ModelName", + "traits": { + "smithy.api#documentation": "The name of the model whose retraining scheduler you want to update.
", + "smithy.api#required": {} + } + }, + "RetrainingStartDate": { + "target": "com.amazonaws.lookoutequipment#Timestamp", + "traits": { + "smithy.api#documentation": "The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the\n nearest UTC day.
" + } + }, + "RetrainingFrequency": { + "target": "com.amazonaws.lookoutequipment#RetrainingFrequency", + "traits": { + "smithy.api#documentation": "This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in\n terms of Years, Months, and/or Days (note: other parameters like Time are not currently\n supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For\n example, the following values are valid:
\nP3M15D – Every 3 months and 15 days
\nP2M – Every 2 months
\nP150D – Every 150 days
\nThe number of past days of data that will be used for retraining.
" + } + }, + "PromoteMode": { + "target": "com.amazonaws.lookoutequipment#ModelPromoteMode", + "traits": { + "smithy.api#documentation": "Indicates how the service will use new models. In MANAGED mode, new models\n will automatically be used for inference if they have better performance than the current\n model. In MANUAL mode, the new models will not be used until they\n are manually activated.
The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services\n service that's being utilized.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.lookoutequipment#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The request could not be completed because you do not have access to the resource.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.lookoutequipment#AmazonResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1011 - } - } - }, - "com.amazonaws.lookoutequipment#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.lookoutequipment#BoundedLengthString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5000 - }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,5000}$" - } - }, - "com.amazonaws.lookoutequipment#CategoricalValues": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", - "traits": { - "smithy.api#documentation": "Indicates whether there is a potential data issue related to categorical values.\n
", - "smithy.api#required": {} - } - }, - "NumberOfCategory": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the number of categories in the data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information on categorical values in data.
" - } - }, - "com.amazonaws.lookoutequipment#Comments": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2560 - }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,2560}$" - } - }, - "com.amazonaws.lookoutequipment#ComponentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z._\\-]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#ComponentTimestampDelimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - }, - "smithy.api#pattern": "^(\\-|\\_|\\s)?$" - } - }, - "com.amazonaws.lookoutequipment#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The request could not be completed due to a conflict with the current state of the\n target resource.
", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.lookoutequipment#CountPercent": { - "type": "structure", - "members": { - "Count": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the count of occurences of the given statistic.
", - "smithy.api#required": {} - } - }, - "Percentage": { - "target": "com.amazonaws.lookoutequipment#Float", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "Indicates the percentage of occurances of the given statistic.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information of count and percentage.
" - } - }, - "com.amazonaws.lookoutequipment#CreateDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#CreateDatasetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#CreateDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a container for a collection of data being ingested for analysis. The dataset\n contains the metadata describing where the data is and what the data actually looks like.\n For example, it contains the location of the data source, the data schema, and other\n information. A dataset also contains any tags associated with the ingested data.
" - } - }, - "com.amazonaws.lookoutequipment#CreateDatasetRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset being created.
", - "smithy.api#required": {} - } - }, - "DatasetSchema": { - "target": "com.amazonaws.lookoutequipment#DatasetSchema", - "traits": { - "smithy.api#documentation": "A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.
" - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#NameOrArn", - "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout\n for Equipment.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.lookoutequipment#TagList", - "traits": { - "smithy.api#documentation": "Any tags associated with the ingested data described in the dataset.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#CreateDatasetResponse": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset being created.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset being created.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#DatasetStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the CreateDataset operation.
Creates a scheduled inference. Scheduling an inference is setting up a continuous\n real-time inference plan to analyze new measurement data. When setting up the schedule, you\n provide an S3 bucket location for the input data, assign it a delimiter between separate\n entries in the data, set an offset delay if desired, and set the frequency of inferencing.\n You must also provide an S3 bucket location for the output data.
" - } - }, - "com.amazonaws.lookoutequipment#CreateInferenceSchedulerRequest": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the previously trained ML model being used to create the inference\n scheduler.
", - "smithy.api#required": {} - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler being created.
", - "smithy.api#required": {} - } - }, - "DataDelayOffsetInMinutes": { - "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", - "traits": { - "smithy.api#documentation": "The interval (in minutes) of planned delay at the start of each inference segment. For\n example, if inference is set to run every ten minutes, the delay is set to five minutes and the time is 09:08. The inference scheduler will wake up at the\n configured interval (which, without a delay configured, would be 09:10) plus the additional five minute delay time (so 09:15) to check your Amazon S3\n bucket. The delay provides a buffer for you to upload data at the same frequency, so that you don't have to stop and\n restart the scheduler when uploading new data.
\nFor more information, see Understanding the inference process.
" - } - }, - "DataUploadFrequency": { - "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", - "traits": { - "smithy.api#documentation": "How often data is uploaded to the source Amazon S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment runs inference on your data.
\nFor more information, see Understanding the inference process.
", - "smithy.api#required": {} - } - }, - "DataInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference scheduler,\n including delimiter, format, and dataset location.
", - "smithy.api#required": {} - } - }, - "DataOutputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the output results for the inference scheduler,\n including the S3 location for the output.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source being\n used for the inference.
", - "smithy.api#required": {} - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#NameOrArn", - "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt inference scheduler data by\n Amazon Lookout for Equipment.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.lookoutequipment#TagList", - "traits": { - "smithy.api#documentation": "Any tags associated with the inference scheduler.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#CreateInferenceSchedulerResponse": { - "type": "structure", - "members": { - "InferenceSchedulerArn": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being created.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of inference scheduler being created.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the CreateInferenceScheduler operation.
\n Creates a label for an event.\n
" - } - }, - "com.amazonaws.lookoutequipment#CreateLabelGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#CreateLabelGroupRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#CreateLabelGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Creates a group of labels.\n
" - } - }, - "com.amazonaws.lookoutequipment#CreateLabelGroupRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n Names a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.\n
", - "smithy.api#required": {} - } - }, - "FaultCodes": { - "target": "com.amazonaws.lookoutequipment#FaultCodes", - "traits": { - "smithy.api#documentation": "\n The acceptable fault codes (indicating the type of anomaly associated with the label) that can be used with this label group.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "\n A unique identifier for the request to create a label group. If you do not set the client request token, Lookout for Equipment generates one.\n
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.lookoutequipment#TagList", - "traits": { - "smithy.api#documentation": "\n Tags that provide metadata about the label group you are creating.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#CreateLabelGroupResponse": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group that you have created. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n
" - } - }, - "LabelGroupArn": { - "target": "com.amazonaws.lookoutequipment#LabelGroupArn", - "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group that you have created.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#CreateLabelRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of a group of labels.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.\n
", - "smithy.api#required": {} - } - }, - "StartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The start time of the labeled event.\n
", - "smithy.api#required": {} - } - }, - "EndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The end time of the labeled event.\n
", - "smithy.api#required": {} - } - }, - "Rating": { - "target": "com.amazonaws.lookoutequipment#LabelRating", - "traits": { - "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
", - "smithy.api#required": {} - } - }, - "FaultCode": { - "target": "com.amazonaws.lookoutequipment#FaultCode", - "traits": { - "smithy.api#documentation": "\n Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.\n
" - } - }, - "Notes": { - "target": "com.amazonaws.lookoutequipment#Comments", - "traits": { - "smithy.api#documentation": "\n Metadata providing additional information about the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - }, - "Equipment": { - "target": "com.amazonaws.lookoutequipment#Equipment", - "traits": { - "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "\n A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.\n
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#CreateLabelResponse": { - "type": "structure", - "members": { - "LabelId": { - "target": "com.amazonaws.lookoutequipment#LabelId", - "traits": { - "smithy.api#documentation": "\n The ID of the label that you have created.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#CreateModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#CreateModelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#CreateModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an ML model for data inference.
\nA machine-learning (ML) model is a mathematical model that finds patterns in your data.\n In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and\n detects abnormal behavior that could be potential equipment failure (or maintenance\n events). The models are made by analyzing normal data and abnormalities in machine behavior\n that have already occurred.
\nYour model is trained using a portion of the data from your dataset and uses that data\n to learn patterns of normal behavior and abnormal patterns that lead to equipment failure.\n Another portion of the data is used to evaluate the model's accuracy.
" - } - }, - "com.amazonaws.lookoutequipment#CreateModelRequest": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name for the ML model to be created.
", - "smithy.api#required": {} - } - }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", - "traits": { - "smithy.api#documentation": "The name of the dataset for the ML model being created.
", - "smithy.api#required": {} - } - }, - "DatasetSchema": { - "target": "com.amazonaws.lookoutequipment#DatasetSchema", - "traits": { - "smithy.api#documentation": "The data schema for the ML model being created.
" - } - }, - "LabelsInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration", - "traits": { - "smithy.api#documentation": "The input configuration for the labels being used for the ML model that's being created.\n
" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "TrainingDataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n training data for the ML model.
" - } - }, - "TrainingDataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n training data for the ML model.
" - } - }, - "EvaluationDataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to begin the subset of\n evaluation data for the ML model.
" - } - }, - "EvaluationDataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that should be used to end the subset of\n evaluation data for the ML model.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source\n being used to create the ML model.
" - } - }, - "DataPreProcessingConfiguration": { - "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", - "traits": { - "smithy.api#documentation": "The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout\n for Equipment.
" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutequipment#TagList", - "traits": { - "smithy.api#documentation": "Any tags associated with the ML model being created.
" - } - }, - "OffCondition": { - "target": "com.amazonaws.lookoutequipment#OffCondition", - "traits": { - "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#CreateModelResponse": { - "type": "structure", - "members": { - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model being created.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#ModelStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the CreateModel operation.
Indicates the job ID of the data ingestion job.
" - } - }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset used for the data ingestion job.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used in the data ingestion job.
" - } - }, - "IngestionInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies information for the input data for the data inference job, including data\n Amazon S3 location parameters.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the data ingestion job.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about a specified data ingestion job, including dataset\n information, data ingestion configuration, and status.
" - } - }, - "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration": { - "type": "structure", - "members": { - "TargetSamplingRate": { - "target": "com.amazonaws.lookoutequipment#TargetSamplingRate", - "traits": { - "smithy.api#documentation": "The sampling rate of the data after post processing by Amazon Lookout for Equipment. For\n example, if you provide data that has been collected at a 1 second level and you want the\n system to resample the data at a 1 minute rate before training, the\n TargetSamplingRate is 1 minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Parameter that gives information about insufficient data for sensors in the dataset.\n This includes information about those sensors that have complete data missing and those\n with a short date range.
", - "smithy.api#required": {} - } - }, - "MissingSensorData": { - "target": "com.amazonaws.lookoutequipment#MissingSensorData", - "traits": { - "smithy.api#documentation": "Parameter that gives information about data that is missing over all the sensors in the\n input data.
", - "smithy.api#required": {} - } - }, - "InvalidSensorData": { - "target": "com.amazonaws.lookoutequipment#InvalidSensorData", - "traits": { - "smithy.api#documentation": "Parameter that gives information about data that is invalid over all the sensors in the\n input data.
", - "smithy.api#required": {} - } - }, - "UnsupportedTimestamps": { - "target": "com.amazonaws.lookoutequipment#UnsupportedTimestamps", - "traits": { - "smithy.api#documentation": "Parameter that gives information about unsupported timestamps in the input data.\n
", - "smithy.api#required": {} - } - }, - "DuplicateTimestamps": { - "target": "com.amazonaws.lookoutequipment#DuplicateTimestamps", - "traits": { - "smithy.api#documentation": "Parameter that gives information about duplicate timestamps in the input data.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "DataQualitySummary gives aggregated statistics over all the sensors about a completed\n ingestion job. It primarily gives more information about statistics over different\n incorrect data like MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,\n InsufficientSensorData, DuplicateTimeStamps.
" - } - }, - "com.amazonaws.lookoutequipment#DataSizeInBytes": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.lookoutequipment#DataUploadFrequency": { - "type": "enum", - "members": { - "PT5M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT5M" - } - }, - "PT10M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT10M" - } - }, - "PT15M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT15M" - } - }, - "PT30M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT30M" - } - }, - "PT1H": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT1H" - } - } - } - }, - "com.amazonaws.lookoutequipment#DatasetArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:dataset\\/.+$" - } - }, - "com.amazonaws.lookoutequipment#DatasetIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#DatasetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#DatasetSchema": { - "type": "structure", - "members": { - "InlineDataSchema": { - "target": "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema", - "traits": { - "smithy.api#documentation": "\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about the data schema used with the given dataset.
" - } - }, - "com.amazonaws.lookoutequipment#DatasetStatus": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "INGESTION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION_IN_PROGRESS" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "IMPORT_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.lookoutequipment#DatasetSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#DatasetSummary" - } - }, - "com.amazonaws.lookoutequipment#DatasetSummary": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified dataset.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#DatasetStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the dataset.
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the dataset was created in Amazon Lookout for Equipment.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the specific data set, including name, ARN, and status.\n
" - } - }, - "com.amazonaws.lookoutequipment#DeleteDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DeleteDatasetRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes a dataset and associated artifacts. The operation will check to see if any\n inference scheduler or data ingestion job is currently using the dataset, and if there\n isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted.\n This does not affect any models that used this dataset for training and evaluation, but\n does prevent it from being used in the future.
" - } - }, - "com.amazonaws.lookoutequipment#DeleteDatasetRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", - "traits": { - "smithy.api#documentation": "The name of the dataset to be deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DeleteInferenceScheduler": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DeleteInferenceSchedulerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an inference scheduler that has been set up. Already processed output results\n are not affected.
" - } - }, - "com.amazonaws.lookoutequipment#DeleteInferenceSchedulerRequest": { - "type": "structure", - "members": { - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler to be deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DeleteLabel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DeleteLabelRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Deletes a label.\n
" - } - }, - "com.amazonaws.lookoutequipment#DeleteLabelGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Deletes a group of labels.\n
" - } - }, - "com.amazonaws.lookoutequipment#DeleteLabelGroupRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DeleteLabelRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group that contains the label that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.\n
", - "smithy.api#required": {} - } - }, - "LabelId": { - "target": "com.amazonaws.lookoutequipment#LabelId", - "traits": { - "smithy.api#documentation": "\n The ID of the label that you want to delete.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DeleteModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DeleteModelRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes an ML model currently available for Amazon Lookout for Equipment. This will\n prevent it from being used with an inference scheduler, even one that is already set up.\n
" - } - }, - "com.amazonaws.lookoutequipment#DeleteModelRequest": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model to be deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DeleteResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the resource policy attached to the resource.
" - } - }, - "com.amazonaws.lookoutequipment#DeleteResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutequipment#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the resource policy should be deleted.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeDataIngestionJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Provides information on a specific data ingestion job such as creation time, dataset\n ARN, and status.
" - } - }, - "com.amazonaws.lookoutequipment#DescribeDataIngestionJobRequest": { - "type": "structure", - "members": { - "JobId": { - "target": "com.amazonaws.lookoutequipment#IngestionJobId", - "traits": { - "smithy.api#documentation": "The job ID of the data ingestion job.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeDataIngestionJobResponse": { - "type": "structure", - "members": { - "JobId": { - "target": "com.amazonaws.lookoutequipment#IngestionJobId", - "traits": { - "smithy.api#documentation": "Indicates the job ID of the data ingestion job.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset being used in the data ingestion job.\n
" - } - }, - "IngestionInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the S3 location configuration for the data input for the data ingestion job.\n
" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role with permission to access the data source\n being ingested.
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the data ingestion job was created.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the DataIngestionJob operation.
Specifies the reason for failure when a data ingestion job has failed.
" - } - }, - "DataQualitySummary": { - "target": "com.amazonaws.lookoutequipment#DataQualitySummary", - "traits": { - "smithy.api#documentation": "Gives statistics about a completed ingestion job. These statistics primarily relate to\n quantifying incorrect data such as MissingCompleteSensorData, MissingSensorData,\n UnsupportedDateFormats, InsufficientSensorData, and DuplicateTimeStamps.
" - } - }, - "IngestedFilesSummary": { - "target": "com.amazonaws.lookoutequipment#IngestedFilesSummary" - }, - "StatusDetail": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#documentation": "Provides details about status of the ingestion job that is currently in progress.\n
" - } - }, - "IngestedDataSize": { - "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", - "traits": { - "smithy.api#documentation": "Indicates the size of the ingested dataset.
" - } - }, - "DataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the earliest timestamp corresponding to data that was successfully ingested\n during this specific ingestion job.
" - } - }, - "DataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the latest timestamp corresponding to data that was successfully ingested\n during this specific ingestion job.
" - } - }, - "SourceDatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the data \n used for the data ingestion job was imported from.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeDatasetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Provides a JSON description of the data in each time series dataset, including names,\n column names, and data types.
" - } - }, - "com.amazonaws.lookoutequipment#DescribeDatasetRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", - "traits": { - "smithy.api#documentation": "The name of the dataset to be described.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeDatasetResponse": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset being described.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset being described.
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Specifies the time the dataset was created in Lookout for Equipment.
" - } - }, - "LastUpdatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Specifies the time the dataset was last updated, if it was.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#DatasetStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the dataset.
" - } - }, - "Schema": { - "target": "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema", - "traits": { - "smithy.api#documentation": "A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.
" - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#KmsKeyArn", - "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt dataset data by Amazon Lookout\n for Equipment.
" - } - }, - "IngestionInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies the S3 location configuration for the data input for the data ingestion job.\n
" - } - }, - "DataQualitySummary": { - "target": "com.amazonaws.lookoutequipment#DataQualitySummary", - "traits": { - "smithy.api#documentation": "Gives statistics associated with the given dataset for the latest successful associated\n ingestion job id. These statistics primarily relate to quantifying incorrect data such as\n MissingCompleteSensorData, MissingSensorData, UnsupportedDateFormats,\n InsufficientSensorData, and DuplicateTimeStamps.
" - } - }, - "IngestedFilesSummary": { - "target": "com.amazonaws.lookoutequipment#IngestedFilesSummary", - "traits": { - "smithy.api#documentation": "IngestedFilesSummary associated with the given dataset for the latest successful\n associated ingestion job id.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that you are using for this the data\n ingestion job.
" - } - }, - "DataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the earliest timestamp corresponding to data that was successfully ingested\n during the most recent ingestion of this particular dataset.
" - } - }, - "DataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the latest timestamp corresponding to data that was successfully ingested\n during the most recent ingestion of this particular dataset.
" - } - }, - "SourceDatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source dataset from which the \n current data being described was imported from.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeInferenceScheduler": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Specifies information about the inference scheduler being used, including name, model,\n status, and associated metadata
" - } - }, - "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerRequest": { - "type": "structure", - "members": { - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler being described.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeInferenceSchedulerResponse": { - "type": "structure", - "members": { - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model of the inference scheduler being\n described.
" - } - }, - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model of the inference scheduler being described.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler being described.
" - } - }, - "InferenceSchedulerArn": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being described.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the inference scheduler.
" - } - }, - "DataDelayOffsetInMinutes": { - "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", - "traits": { - "smithy.api#documentation": "A period of time (in minutes) by which inference on the data is delayed after the data\n starts. For instance, if you select an offset delay time of five minutes, inference will\n not begin on the data until the first data measurement after the five minute mark. For\n example, if five minutes is selected, the inference scheduler will wake up at the\n configured frequency with the additional five minute delay time to check the customer S3\n bucket. The customer can upload data at the same frequency and they don't need to stop and\n restart the scheduler when uploading new data.
" - } - }, - "DataUploadFrequency": { - "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", - "traits": { - "smithy.api#documentation": "Specifies how often data is uploaded to the source S3 bucket for the input data. This\n value is the length of time between data uploads. For instance, if you select 5 minutes,\n Amazon Lookout for Equipment will upload the real-time data to the source bucket once every\n 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a\n scheduled inference on your data. In this example, it starts once every 5 minutes.
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Specifies the time at which the inference scheduler was created.
" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Specifies the time at which the inference scheduler was last updated, if it was.
" - } - }, - "DataInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference scheduler,\n including delimiter, format, and dataset location.
" - } - }, - "DataOutputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies information for the output results for the inference scheduler, including\n the output S3 location.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the inference scheduler being described.
" - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#KmsKeyArn", - "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt inference scheduler data by\n Amazon Lookout for Equipment.
" - } - }, - "LatestInferenceResult": { - "target": "com.amazonaws.lookoutequipment#LatestInferenceResult", - "traits": { - "smithy.api#documentation": "Indicates whether the latest execution for the inference scheduler was Anomalous\n (anomalous events found) or Normal (no anomalous events found).
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeLabel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeLabelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeLabelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Returns the name of the label.\n
" - } - }, - "com.amazonaws.lookoutequipment#DescribeLabelGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeLabelGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Returns information about the label group.\n
" - } - }, - "com.amazonaws.lookoutequipment#DescribeLabelGroupRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n Returns the name of the label group.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeLabelGroupResponse": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group.\n
" - } - }, - "LabelGroupArn": { - "target": "com.amazonaws.lookoutequipment#LabelGroupArn", - "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" - } - }, - "FaultCodes": { - "target": "com.amazonaws.lookoutequipment#FaultCodes", - "traits": { - "smithy.api#documentation": "\n Codes indicating the type of anomaly associated with the labels in the lagbel group.\n
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The time at which the label group was created.\n
" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The time at which the label group was updated.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeLabelRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n Returns the name of the group containing the label.\n
", - "smithy.api#required": {} - } - }, - "LabelId": { - "target": "com.amazonaws.lookoutequipment#LabelId", - "traits": { - "smithy.api#documentation": "\n Returns the ID of the label.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeLabelResponse": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the requested label group.\n
" - } - }, - "LabelGroupArn": { - "target": "com.amazonaws.lookoutequipment#LabelGroupArn", - "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the requested label group.\n
" - } - }, - "LabelId": { - "target": "com.amazonaws.lookoutequipment#LabelId", - "traits": { - "smithy.api#documentation": "\n The ID of the requested label.\n
" - } - }, - "StartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The start time of the requested label.\n
" - } - }, - "EndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The end time of the requested label.\n
" - } - }, - "Rating": { - "target": "com.amazonaws.lookoutequipment#LabelRating", - "traits": { - "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
" - } - }, - "FaultCode": { - "target": "com.amazonaws.lookoutequipment#FaultCode", - "traits": { - "smithy.api#documentation": "\n Indicates the type of anomaly associated with the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - }, - "Notes": { - "target": "com.amazonaws.lookoutequipment#Comments", - "traits": { - "smithy.api#documentation": "Metadata providing additional information about the label.
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - }, - "Equipment": { - "target": "com.amazonaws.lookoutequipment#Equipment", - "traits": { - "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The time at which the label was created.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeModel": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeModelRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeModelResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Provides a JSON containing the overall information about a specific ML model, including\n model name and ARN, dataset, training and evaluation information, status, and so on.\n
" - } - }, - "com.amazonaws.lookoutequipment#DescribeModelRequest": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model to be described.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeModelResponse": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model being described.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model being described.
" - } - }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset being used by the ML being described.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resouce Name (ARN) of the dataset used to create the ML model being\n described.
" - } - }, - "Schema": { - "target": "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema", - "traits": { - "smithy.api#documentation": "A JSON description of the data that is in each time series dataset, including names,\n column names, and data types.
" - } - }, - "LabelsInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information about the labels input, including its S3 location.\n
" - } - }, - "TrainingDataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n training data for the ML model.
" - } - }, - "TrainingDataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of training\n data for the ML model.
" - } - }, - "EvaluationDataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to begin the subset of\n evaluation data for the ML model.
" - } - }, - "EvaluationDataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset that was used to end the subset of\n evaluation data for the ML model.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the ML model being described.
" - } - }, - "DataPreProcessingConfiguration": { - "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration", - "traits": { - "smithy.api#documentation": "The configuration is the TargetSamplingRate, which is the sampling rate of\n the data after post processing by Amazon Lookout for Equipment. For example, if you provide\n data that has been collected at a 1 second level and you want the system to resample the\n data at a 1 minute rate before training, the TargetSamplingRate is 1\n minute.
When providing a value for the TargetSamplingRate, you must attach the\n prefix \"PT\" to the rate you want. The value for a 1 second rate is therefore\n PT1S, the value for a 15 minute rate is PT15M,\n and the value for a 1 hour rate is PT1H\n
Specifies the current status of the model being described. Status describes the status\n of the most recent action of the model.
" - } - }, - "TrainingExecutionStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time at which the training of the ML model began.
" - } - }, - "TrainingExecutionEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time at which the training of the ML model was completed.
" - } - }, - "FailedReason": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#documentation": "If the training of the ML model failed, this indicates the reason for that failure.\n
" - } - }, - "ModelMetrics": { - "target": "com.amazonaws.lookoutequipment#SynthesizedJsonModelMetrics", - "traits": { - "smithy.api#documentation": "The Model Metrics show an aggregated summary of the model's performance within the\n evaluation time range. This is the JSON content of the metrics created when evaluating the\n model.
" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the last time the ML model was updated. The type of update is not specified.\n
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time and date at which the ML model was created.
" - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#KmsKeyArn", - "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key used to encrypt model data by Amazon Lookout\n for Equipment.
" - } - }, - "OffCondition": { - "target": "com.amazonaws.lookoutequipment#OffCondition", - "traits": { - "smithy.api#documentation": "Indicates that the asset associated with this sensor has been shut off. As long as this\n condition is met, Lookout for Equipment will not use data from this asset for training,\n evaluation, or inference.
" - } - }, - "SourceModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source model version. This field appears if the active model version \n was imported.
" - } - }, - "ImportJobStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time when the import job was started. \n This field appears if the active model version was imported.
" - } - }, - "ImportJobEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time when the import job was completed. \n This field appears if the active model version was imported.
" - } - }, - "ActiveModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The name of the model version used by the inference schedular when running a\n scheduled inference execution.
" - } - }, - "ActiveModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version used by the\n inference scheduler when running a scheduled inference execution.
" - } - }, - "ModelVersionActivatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date the active model version was activated.
" - } - }, - "PreviousActiveModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The model version that was set as the active model version prior to the \n current active model version.
" - } - }, - "PreviousActiveModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The ARN of the model version that was set as the active model version prior to the \n current active model version.
" - } - }, - "PreviousModelVersionActivatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time when the previous active model version was activated.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeModelVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeModelVersionRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeModelVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Retrieves information about a specific machine learning model version.
" - } - }, - "com.amazonaws.lookoutequipment#DescribeModelVersionRequest": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the machine learning model that this version belongs to.
", - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The version of the machine learning model.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeModelVersionResponse": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the machine learning model that this version belongs to.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the parent machine learning model that this version belong to.
" - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The version of the machine learning model.
" - } - }, - "ModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", - "traits": { - "smithy.api#documentation": "The current status of the model version.
" - } - }, - "SourceType": { - "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", - "traits": { - "smithy.api#documentation": "Indicates whether this model version was created by training or by importing.
" - } - }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset used to train the model version.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used to train the model version.
" - } - }, - "Schema": { - "target": "com.amazonaws.lookoutequipment#InlineDataSchema", - "traits": { - "smithy.api#documentation": "The schema of the data used to train the model version.
" - } - }, - "LabelsInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" - }, - "TrainingDataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date on which the training data began being gathered. If you imported\n the version, this is the date that the training data in the source \n version began being gathered.
" - } - }, - "TrainingDataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date on which the training data finished being gathered. \n If you imported the version, this is the date that the training data in the\n source version finished being gathered.
" - } - }, - "EvaluationDataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in \n the source version began being gathered.
" - } - }, - "EvaluationDataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date on which the data in the evaluation set began being gathered. \n If you imported the version, this is the date that the evaluation set data in the\n source version finished being gathered.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that was used to train the model version.
" - } - }, - "DataPreProcessingConfiguration": { - "target": "com.amazonaws.lookoutequipment#DataPreProcessingConfiguration" - }, - "TrainingExecutionStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the training of the version began.
" - } - }, - "TrainingExecutionEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the training of the version completed.
" - } - }, - "FailedReason": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#documentation": "The failure message if the training of the model version failed.
" - } - }, - "ModelMetrics": { - "target": "com.amazonaws.lookoutequipment#ModelMetrics", - "traits": { - "smithy.api#documentation": "Shows an aggregated summary, in JSON format, of the model's \n performance within the evaluation time range. These metrics \n are created when evaluating the model.
" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the last time the machine learning model version was updated.
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time and date at which the machine learning model version was created.
" - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#KmsKeyArn", - "traits": { - "smithy.api#documentation": "The identifier of the KMS key key used to encrypt model version data by \n Amazon Lookout for Equipment.
" - } - }, - "OffCondition": { - "target": "com.amazonaws.lookoutequipment#OffCondition", - "traits": { - "smithy.api#documentation": "Indicates that the asset associated with this sensor has been \n shut off. As long as this condition is met, Lookout for Equipment \n will not use data from this asset for training, evaluation, or inference.
" - } - }, - "SourceModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "If model version was imported, then this field is the arn\n of the source model version.
" - } - }, - "ImportJobStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time when the import job began. \n This field appears if the model version was imported.
" - } - }, - "ImportJobEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time when the import job completed. \n This field appears if the model version was imported.
" - } - }, - "ImportedDataSizeInBytes": { - "target": "com.amazonaws.lookoutequipment#DataSizeInBytes", - "traits": { - "smithy.api#documentation": "The size in bytes of the imported data. \n This field appears if the model version was imported.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#DescribeResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Provides the details of a resource policy attached to a resource.
" - } - }, - "com.amazonaws.lookoutequipment#DescribeResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutequipment#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that is associated with the resource policy.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#DescribeResourcePolicyResponse": { - "type": "structure", - "members": { - "PolicyRevisionId": { - "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", - "traits": { - "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" - } - }, - "ResourcePolicy": { - "target": "com.amazonaws.lookoutequipment#Policy", - "traits": { - "smithy.api#documentation": "The resource policy in a JSON-formatted string.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the resource policy was created.
" - } - }, - "LastModifiedTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time when the resource policy was last modified.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#DuplicateTimestamps": { - "type": "structure", - "members": { - "TotalNumberOfDuplicateTimestamps": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the total number of duplicate timestamps.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information abount duplicate timestamps in the dataset.
" - } - }, - "com.amazonaws.lookoutequipment#Equipment": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#EventDurationInSeconds": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.lookoutequipment#FaultCode": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,100}$" - } - }, - "com.amazonaws.lookoutequipment#FaultCodes": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#FaultCode" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.lookoutequipment#FileNameTimestampFormat": { - "type": "string", - "traits": { - "smithy.api#pattern": "^EPOCH|yyyy-MM-dd-HH-mm-ss|yyyyMMddHHmmss$" - } - }, - "com.amazonaws.lookoutequipment#Float": { - "type": "float", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.lookoutequipment#IamRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" - } - }, - "com.amazonaws.lookoutequipment#IdempotenceToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^\\p{ASCII}{1,256}$" - } - }, - "com.amazonaws.lookoutequipment#ImportDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ImportDatasetRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ImportDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Imports a dataset.
" - } - }, - "com.amazonaws.lookoutequipment#ImportDatasetRequest": { - "type": "structure", - "members": { - "SourceDatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset to import.
", - "smithy.api#required": {} - } - }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the machine learning dataset to be created. If the dataset already exists, Amazon Lookout for Equipment overwrites the existing dataset. If you don't specify this field, it is filled with the name of the source dataset.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. \n If you do not set the client request token, \n Amazon Lookout for Equipment generates one.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#NameOrArn", - "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key key used to \n encrypt model data by Amazon Lookout for Equipment.
" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutequipment#TagList", - "traits": { - "smithy.api#documentation": "Any tags associated with the dataset to be created.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ImportDatasetResponse": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the created machine learning dataset.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset that was imported.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#DatasetStatus", - "traits": { - "smithy.api#documentation": "The status of the ImportDataset operation.
A unique identifier for the job of importing the dataset.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ImportModelVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ImportModelVersionRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ImportModelVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Imports a model that has been trained successfully.
" - } - }, - "com.amazonaws.lookoutequipment#ImportModelVersionRequest": { - "type": "structure", - "members": { - "SourceModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version to import.
", - "smithy.api#required": {} - } - }, - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name for the machine learning model to be created.\n If the model already exists, Amazon Lookout for Equipment creates a new version. \n If you do not specify this field, it is filled with the name of the source model.
" - } - }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", - "traits": { - "smithy.api#documentation": "The name of the dataset for the machine learning model being imported.
", - "smithy.api#required": {} - } - }, - "LabelsInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#LabelsInputConfiguration" - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request\n token, Amazon Lookout for Equipment generates one.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to \n access the data source being used to create the machine learning model.
" - } - }, - "ServerSideKmsKeyId": { - "target": "com.amazonaws.lookoutequipment#NameOrArn", - "traits": { - "smithy.api#documentation": "Provides the identifier of the KMS key key used to encrypt \n model data by Amazon Lookout for Equipment.
" - } - }, - "Tags": { - "target": "com.amazonaws.lookoutequipment#TagList", - "traits": { - "smithy.api#documentation": "The tags associated with the machine learning model to be created.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ImportModelVersionResponse": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name for the machine learning model.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model being created.
" - } - }, - "ModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version being created.
" - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The version of the model being created.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", - "traits": { - "smithy.api#documentation": "The status of the ImportModelVersion operation.
The Amazon Resource Name (ARN) of the inference scheduler being used for the inference\n event.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler being used for the inference events.
" - } - }, - "EventStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the starting time of an inference event.
" - } - }, - "EventEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the ending time of an inference event.
" - } - }, - "Diagnostics": { - "target": "com.amazonaws.lookoutequipment#ModelMetrics", - "traits": { - "smithy.api#documentation": "An array which specifies the names and values of all sensors contributing to an\n inference event.
" - } - }, - "EventDurationInSeconds": { - "target": "com.amazonaws.lookoutequipment#EventDurationInSeconds", - "traits": { - "smithy.api#documentation": "Indicates the size of an inference event in seconds.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the specific inference event, including start and end time,\n diagnostics information, event duration and so on.
" - } - }, - "com.amazonaws.lookoutequipment#InferenceExecutionStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.lookoutequipment#InferenceExecutionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#InferenceExecutionSummary" - } - }, - "com.amazonaws.lookoutequipment#InferenceExecutionSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model being used for the inference execution.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model used for the inference execution.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler being used for the inference execution.
" - } - }, - "InferenceSchedulerArn": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being used for the inference\n execution.
" - } - }, - "ScheduledStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the start time at which the inference scheduler began the specific inference\n execution.
" - } - }, - "DataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset at which the inference execution began.\n
" - } - }, - "DataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference in the dataset at which the inference execution stopped.\n
" - } - }, - "DataInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference scheduler,\n including delimiter, format, and dataset location.
" - } - }, - "DataOutputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the output results from for the inference\n execution, including the output Amazon S3 location.\n
" - } - }, - "CustomerResultObject": { - "target": "com.amazonaws.lookoutequipment#S3Object", - "traits": { - "smithy.api#documentation": "\n
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceExecutionStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the inference execution.
" - } - }, - "FailedReason": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#documentation": "Specifies the reason for failure when an inference execution has failed.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the specific inference execution, including input and output\n data configuration, inference scheduling information, status, and so on.
" - } - }, - "com.amazonaws.lookoutequipment#InferenceInputConfiguration": { - "type": "structure", - "members": { - "S3InputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceS3InputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n Amazon S3 location of input data.
" - } - }, - "InputTimeZoneOffset": { - "target": "com.amazonaws.lookoutequipment#TimeZoneOffset", - "traits": { - "smithy.api#documentation": "Indicates the difference between your time zone and Coordinated Universal Time\n (UTC).
" - } - }, - "InferenceInputNameConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceInputNameConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n timestamp format and delimiter.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n Amazon S3 location of input data..
" - } - }, - "com.amazonaws.lookoutequipment#InferenceInputNameConfiguration": { - "type": "structure", - "members": { - "TimestampFormat": { - "target": "com.amazonaws.lookoutequipment#FileNameTimestampFormat", - "traits": { - "smithy.api#documentation": "The format of the timestamp, whether Epoch time, or standard, with or without hyphens\n (-).
" - } - }, - "ComponentTimestampDelimiter": { - "target": "com.amazonaws.lookoutequipment#ComponentTimestampDelimiter", - "traits": { - "smithy.api#documentation": "Indicates the delimiter character used between items in the data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n timestamp format and delimiter.
" - } - }, - "com.amazonaws.lookoutequipment#InferenceOutputConfiguration": { - "type": "structure", - "members": { - "S3OutputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceS3OutputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies configuration information for the output results from for the inference,\n output S3 location.
", - "smithy.api#required": {} - } - }, - "KmsKeyId": { - "target": "com.amazonaws.lookoutequipment#NameOrArn", - "traits": { - "smithy.api#documentation": "The ID number for the KMS key key used to encrypt the inference output.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies configuration information for the output results from for the inference,\n including KMS key ID and output S3 location.
" - } - }, - "com.amazonaws.lookoutequipment#InferenceS3InputConfiguration": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutequipment#S3Bucket", - "traits": { - "smithy.api#documentation": "The bucket containing the input dataset for the inference.
", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.lookoutequipment#S3Prefix", - "traits": { - "smithy.api#documentation": "The prefix for the S3 bucket used for the input data for the inference.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the inference, including\n input data S3 location.
" - } - }, - "com.amazonaws.lookoutequipment#InferenceS3OutputConfiguration": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutequipment#S3Bucket", - "traits": { - "smithy.api#documentation": "The bucket containing the output results from the inference
", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.lookoutequipment#S3Prefix", - "traits": { - "smithy.api#documentation": "The prefix for the S3 bucket used for the output results from the inference.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies configuration information for the output results from the inference,\n including output S3 location.
" - } - }, - "com.amazonaws.lookoutequipment#InferenceSchedulerArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:inference-scheduler\\/.+$" - } - }, - "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#InferenceSchedulerName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#InferenceSchedulerStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "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.lookoutequipment#InferenceSchedulerSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerSummary" - } - }, - "com.amazonaws.lookoutequipment#InferenceSchedulerSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model used for the inference scheduler.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model used by the inference scheduler.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler.
" - } - }, - "InferenceSchedulerArn": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the inference scheduler.
" - } - }, - "DataDelayOffsetInMinutes": { - "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", - "traits": { - "smithy.api#documentation": "A period of time (in minutes) by which inference on the data is delayed after the data\n starts. For instance, if an offset delay time of five minutes was selected, inference will\n not begin on the data until the first data measurement after the five minute mark. For\n example, if five minutes is selected, the inference scheduler will wake up at the\n configured frequency with the additional five minute delay time to check the customer S3\n bucket. The customer can upload data at the same frequency and they don't need to stop and\n restart the scheduler when uploading new data.
" - } - }, - "DataUploadFrequency": { - "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", - "traits": { - "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. This value is the\n length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout\n for Equipment will upload the real-time data to the source bucket once every 5 minutes.\n This frequency also determines how often Amazon Lookout for Equipment starts a scheduled\n inference on your data. In this example, it starts once every 5 minutes.
" - } - }, - "LatestInferenceResult": { - "target": "com.amazonaws.lookoutequipment#LatestInferenceResult", - "traits": { - "smithy.api#documentation": "Indicates whether the latest execution for the inference scheduler was Anomalous\n (anomalous events found) or Normal (no anomalous events found).
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the specific inference scheduler, including data delay\n offset, model name and ARN, status, and so on.
" - } - }, - "com.amazonaws.lookoutequipment#IngestedFilesSummary": { - "type": "structure", - "members": { - "TotalNumberOfFiles": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the total number of files that were submitted for ingestion.
", - "smithy.api#required": {} - } - }, - "IngestedNumberOfFiles": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the number of files that were successfully ingested.
", - "smithy.api#required": {} - } - }, - "DiscardedFiles": { - "target": "com.amazonaws.lookoutequipment#ListOfDiscardedFiles", - "traits": { - "smithy.api#documentation": "Indicates the number of files that were discarded. A file could be discarded because its\n format is invalid (for example, a jpg or pdf) or not readable.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Gives statistics about how many files have been ingested, and which files have not been\n ingested, for a particular ingestion job.
" - } - }, - "com.amazonaws.lookoutequipment#IngestionInputConfiguration": { - "type": "structure", - "members": { - "S3InputConfiguration": { - "target": "com.amazonaws.lookoutequipment#IngestionS3InputConfiguration", - "traits": { - "smithy.api#documentation": "The location information for the S3 bucket used for input data for the data ingestion.\n
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies configuration information for the input data for the data ingestion job,\n including input data S3 location.
" - } - }, - "com.amazonaws.lookoutequipment#IngestionJobId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[A-Fa-f0-9]{0,32}$" - } - }, - "com.amazonaws.lookoutequipment#IngestionJobStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IMPORT_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.lookoutequipment#IngestionS3InputConfiguration": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutequipment#S3Bucket", - "traits": { - "smithy.api#documentation": "The name of the S3 bucket used for the input data for the data ingestion.
", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.lookoutequipment#S3Prefix", - "traits": { - "smithy.api#documentation": "The prefix for the S3 location being used for the input data for the data ingestion.\n
" - } - }, - "KeyPattern": { - "target": "com.amazonaws.lookoutequipment#KeyPattern", - "traits": { - "smithy.api#documentation": "\n\t\t\t The pattern for matching the Amazon S3 files that will be used for ingestion. If the schema was created previously without any KeyPattern, then the default KeyPattern {prefix}/{component_name}/* is used to download files from Amazon S3 according to the schema. This field is required when ingestion is being done for the first time.
\nValid Values: {prefix}/{component_name}_* | {prefix}/{component_name}/* | {prefix}/{component_name}[DELIMITER]* (Allowed delimiters : space, dot, underscore, hyphen)
" - } - } - }, - "traits": { - "smithy.api#documentation": "Specifies S3 configuration information for the input data for the data ingestion job.\n
" - } - }, - "com.amazonaws.lookoutequipment#InlineDataSchema": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000000 - } - } - }, - "com.amazonaws.lookoutequipment#InsufficientSensorData": { - "type": "structure", - "members": { - "MissingCompleteSensorData": { - "target": "com.amazonaws.lookoutequipment#MissingCompleteSensorData", - "traits": { - "smithy.api#documentation": "Parameter that describes the total number of sensors that have data completely missing\n for it.
", - "smithy.api#required": {} - } - }, - "SensorsWithShortDateRange": { - "target": "com.amazonaws.lookoutequipment#SensorsWithShortDateRange", - "traits": { - "smithy.api#documentation": "Parameter that describes the total number of sensors that have a short date range of\n less than 90 days of data overall.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises aggregated information on sensors having insufficient data.\n
" - } - }, - "com.amazonaws.lookoutequipment#Integer": { - "type": "integer" - }, - "com.amazonaws.lookoutequipment#InternalServerException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Processing of the request has failed because of an unknown error, exception or failure.\n
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.lookoutequipment#InvalidSensorData": { - "type": "structure", - "members": { - "AffectedSensorCount": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the number of sensors that have at least some invalid values.
", - "smithy.api#required": {} - } - }, - "TotalNumberOfInvalidValues": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the total number of invalid values across all the sensors.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises aggregated information on sensors having insufficient data.\n
" - } - }, - "com.amazonaws.lookoutequipment#KeyPattern": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.lookoutequipment#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:kms:[a-z0-9\\-]*:\\d{12}:[\\w\\-\\/]+$" - } - }, - "com.amazonaws.lookoutequipment#LabelGroupArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:label-group\\/.+$" - } - }, - "com.amazonaws.lookoutequipment#LabelGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#LabelGroupSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#LabelGroupSummary" - } - }, - "com.amazonaws.lookoutequipment#LabelGroupSummary": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group.\n
" - } - }, - "LabelGroupArn": { - "target": "com.amazonaws.lookoutequipment#LabelGroupArn", - "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The time at which the label group was created.\n
" - } - }, - "UpdatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The time at which the label group was updated.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Contains information about the label group.\n
" - } - }, - "com.amazonaws.lookoutequipment#LabelId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - }, - "smithy.api#pattern": "^[A-Fa-f0-9]{0,32}$" - } - }, - "com.amazonaws.lookoutequipment#LabelRating": { - "type": "enum", - "members": { - "ANOMALY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANOMALY" - } - }, - "NO_ANOMALY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_ANOMALY" - } - }, - "NEUTRAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEUTRAL" - } - } - } - }, - "com.amazonaws.lookoutequipment#LabelSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#LabelSummary" - } - }, - "com.amazonaws.lookoutequipment#LabelSummary": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group.\n
" - } - }, - "LabelId": { - "target": "com.amazonaws.lookoutequipment#LabelId", - "traits": { - "smithy.api#documentation": "\n The ID of the label.\n
" - } - }, - "LabelGroupArn": { - "target": "com.amazonaws.lookoutequipment#LabelGroupArn", - "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the label group.\n
" - } - }, - "StartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The timestamp indicating the start of the label.\n
" - } - }, - "EndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The timestamp indicating the end of the label.\n
" - } - }, - "Rating": { - "target": "com.amazonaws.lookoutequipment#LabelRating", - "traits": { - "smithy.api#documentation": "\n Indicates whether a labeled event represents an anomaly.\n
" - } - }, - "FaultCode": { - "target": "com.amazonaws.lookoutequipment#FaultCode", - "traits": { - "smithy.api#documentation": "\n Indicates the type of anomaly associated with the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - }, - "Equipment": { - "target": "com.amazonaws.lookoutequipment#Equipment", - "traits": { - "smithy.api#documentation": "\n Indicates that a label pertains to a particular piece of equipment.\n
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n The time at which the label was created.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "\n Information about the label.\n
" - } - }, - "com.amazonaws.lookoutequipment#LabelsInputConfiguration": { - "type": "structure", - "members": { - "S3InputConfiguration": { - "target": "com.amazonaws.lookoutequipment#LabelsS3InputConfiguration", - "traits": { - "smithy.api#documentation": "Contains location information for the S3 location being used for label data.
" - } - }, - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group to be used for label data.\n
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains the configuration information for the S3 location being used to hold label\n data.
" - } - }, - "com.amazonaws.lookoutequipment#LabelsS3InputConfiguration": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutequipment#S3Bucket", - "traits": { - "smithy.api#documentation": "The name of the S3 bucket holding the label data.
", - "smithy.api#required": {} - } - }, - "Prefix": { - "target": "com.amazonaws.lookoutequipment#S3Prefix", - "traits": { - "smithy.api#documentation": "The prefix for the S3 bucket used for the label data.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The location information (prefix and bucket name) for the s3 location being used for\n label data.
" - } - }, - "com.amazonaws.lookoutequipment#LargeTimestampGaps": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", - "traits": { - "smithy.api#documentation": "Indicates whether there is a potential data issue related to large gaps in timestamps.\n
", - "smithy.api#required": {} - } - }, - "NumberOfLargeTimestampGaps": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the number of large timestamp gaps, if there are any.
" - } - }, - "MaxTimestampGapInDays": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the size of the largest timestamp gap, in days.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information on large gaps between consecutive timestamps in data.\n
" - } - }, - "com.amazonaws.lookoutequipment#LatestInferenceResult": { - "type": "enum", - "members": { - "ANOMALOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANOMALOUS" - } - }, - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - } - } - }, - "com.amazonaws.lookoutequipment#ListDataIngestionJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListDataIngestionJobsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListDataIngestionJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location\n of the input data, status, and so on.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListDataIngestionJobsRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset being used for the data ingestion job.
" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of data ingestion\n jobs.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of data ingestion jobs to list.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the data ingestion job.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListDataIngestionJobsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of data ingestion\n jobs.
" - } - }, - "DataIngestionJobSummaries": { - "target": "com.amazonaws.lookoutequipment#DataIngestionJobSummaries", - "traits": { - "smithy.api#documentation": "Specifies information about the specific data ingestion job, including dataset name and\n status.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListDatasets": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListDatasetsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListDatasetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all datasets currently available in your account, filtering on the dataset name.\n
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListDatasetsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of datasets.\n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of datasets to list.
" - } - }, - "DatasetNameBeginsWith": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The beginning of the name of the datasets to be listed.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListDatasetsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of datasets.\n
" - } - }, - "DatasetSummaries": { - "target": "com.amazonaws.lookoutequipment#DatasetSummaries", - "traits": { - "smithy.api#documentation": "Provides information about the specified dataset, including creation time, dataset ARN,\n and status.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListInferenceEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListInferenceEventsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListInferenceEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all inference events that have been found for the specified inference scheduler.\n
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListInferenceEventsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n events.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of inference events to list.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler for the inference events listed.
", - "smithy.api#required": {} - } - }, - "IntervalStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Lookout for Equipment will return all the inference events with an end time equal to or greater than the\n start time given.
", - "smithy.api#required": {} - } - }, - "IntervalEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Returns all the inference events with an end start time equal to or greater than less than the end time given.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListInferenceEventsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n executions.
" - } - }, - "InferenceEventSummaries": { - "target": "com.amazonaws.lookoutequipment#InferenceEventSummaries", - "traits": { - "smithy.api#documentation": "Provides an array of information about the individual inference events returned from the\n ListInferenceEvents operation, including scheduler used, event start time,\n event end time, diagnostics, and so on.
Lists all inference executions that have been performed by the specified inference\n scheduler.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListInferenceExecutionsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n executions.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of inference executions to list.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler for the inference execution listed.
", - "smithy.api#required": {} - } - }, - "DataStartTimeAfter": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time reference in the inferenced dataset after which Amazon Lookout for Equipment\n started the inference execution.
" - } - }, - "DataEndTimeBefore": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time reference in the inferenced dataset before which Amazon Lookout for Equipment\n stopped the inference execution.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceExecutionStatus", - "traits": { - "smithy.api#documentation": "The status of the inference execution.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListInferenceExecutionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n executions.
" - } - }, - "InferenceExecutionSummaries": { - "target": "com.amazonaws.lookoutequipment#InferenceExecutionSummaries", - "traits": { - "smithy.api#documentation": "Provides an array of information about the individual inference executions returned from\n the ListInferenceExecutions operation, including model used, inference\n scheduler, data configuration, and so on.
Retrieves a list of all inference schedulers currently available for your account.\n
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListInferenceSchedulersRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n schedulers.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of inference schedulers to list.
" - } - }, - "InferenceSchedulerNameBeginsWith": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The beginning of the name of the inference schedulers to be listed.
" - } - }, - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model used by the inference scheduler to be listed.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", - "traits": { - "smithy.api#documentation": "Specifies the current status of the inference schedulers.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListInferenceSchedulersResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of inference\n schedulers.
" - } - }, - "InferenceSchedulerSummaries": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerSummaries", - "traits": { - "smithy.api#documentation": "Provides information about the specified inference scheduler, including data upload\n frequency, model name and ARN, and status.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListLabelGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListLabelGroupsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListLabelGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Returns a list of the label groups.\n
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListLabelGroupsRequest": { - "type": "structure", - "members": { - "LabelGroupNameBeginsWith": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The beginning of the name of the label groups to be listed.\n
" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "\n Specifies the maximum number of label groups to list.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListLabelGroupsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" - } - }, - "LabelGroupSummaries": { - "target": "com.amazonaws.lookoutequipment#LabelGroupSummaries", - "traits": { - "smithy.api#documentation": "\n A summary of the label groups.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListLabels": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListLabelsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListLabelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Provides a list of labels.\n
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListLabelsRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n Retruns the name of the label group.\n
", - "smithy.api#required": {} - } - }, - "IntervalStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n Returns all the labels with a end time equal to or later than the start time given.\n
" - } - }, - "IntervalEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "\n Returns all labels with a start time earlier than the end time given.\n
" - } - }, - "FaultCode": { - "target": "com.amazonaws.lookoutequipment#FaultCode", - "traits": { - "smithy.api#documentation": "\n Returns labels with a particular fault code.\n
" - } - }, - "Equipment": { - "target": "com.amazonaws.lookoutequipment#Equipment", - "traits": { - "smithy.api#documentation": "\n Lists the labels that pertain to a particular piece of equipment.\n
" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of label groups.\n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "\n Specifies the maximum number of labels to list.\n
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListLabelsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "\n An opaque pagination token indicating where to continue the listing of datasets.\n
" - } - }, - "LabelSummaries": { - "target": "com.amazonaws.lookoutequipment#LabelSummaries", - "traits": { - "smithy.api#documentation": "\n A summary of the items in the label group.\n
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListModelVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListModelVersionsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListModelVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Generates a list of all model versions for a given model, \n including the model version, model version ARN, and status. To list a \n subset of versions, use the MaxModelVersion and MinModelVersion fields.
Then name of the machine learning model for which the \n model versions are to be listed.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.
Specifies the maximum number of machine learning model versions to list.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", - "traits": { - "smithy.api#documentation": "Filter the results based on the current status of the model version.
" - } - }, - "SourceType": { - "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", - "traits": { - "smithy.api#documentation": "Filter the results based on the way the model version was generated.
" - } - }, - "CreatedAtEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Filter results to return all the model versions created before this time.
" - } - }, - "CreatedAtStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Filter results to return all the model versions created after this time.
" - } - }, - "MaxModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "Specifies the highest version of the model to return in the list.
" - } - }, - "MinModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "Specifies the lowest version of the model to return in the list.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListModelVersionsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "If the total number of results exceeds the limit that the response can \n display, the response returns an opaque pagination token indicating where to \n continue the listing of machine learning model versions. Use this token in the NextToken \n field in the request to list the next page of results.
Provides information on the specified model version, \n including the created time, model and dataset ARNs, and status.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListModels": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListModelsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListModelsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Generates a list of all models in the account, including model name and ARN, dataset,\n and status.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListModelsRequest": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of ML models.\n
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of ML models to list.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#ModelStatus", - "traits": { - "smithy.api#documentation": "The status of the ML model.
" - } - }, - "ModelNameBeginsWith": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The beginning of the name of the ML models being listed.
" - } - }, - "DatasetNameBeginsWith": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The beginning of the name of the dataset of the ML models to be listed.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListModelsResponse": { - "type": "structure", - "members": { - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of ML models.\n
" - } - }, - "ModelSummaries": { - "target": "com.amazonaws.lookoutequipment#ModelSummaries", - "traits": { - "smithy.api#documentation": "Provides information on the specified model, including created time, model and dataset\n ARNs, and status.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListOfDiscardedFiles": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#S3Object" - }, - "traits": { - "smithy.api#length": { - "min": 0 - } - } - }, - "com.amazonaws.lookoutequipment#ListSensorStatistics": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListSensorStatisticsRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists statistics about the data collected for each of the sensors that have been\n successfully ingested in the particular dataset. Can also be used to retreive Sensor\n Statistics for a previous ingestion job.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.lookoutequipment#ListSensorStatisticsRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset associated with the list of Sensor Statistics.
", - "smithy.api#required": {} - } - }, - "IngestionJobId": { - "target": "com.amazonaws.lookoutequipment#IngestionJobId", - "traits": { - "smithy.api#documentation": "The ingestion job id associated with the list of Sensor Statistics. To get sensor\n statistics for a particular ingestion job id, both dataset name and ingestion job id must\n be submitted as inputs.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.lookoutequipment#MaxResults", - "traits": { - "smithy.api#documentation": "Specifies the maximum number of sensors for which to retrieve statistics.
" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of sensor\n statistics.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ListSensorStatisticsResponse": { - "type": "structure", - "members": { - "SensorStatisticsSummaries": { - "target": "com.amazonaws.lookoutequipment#SensorStatisticsSummaries", - "traits": { - "smithy.api#documentation": "Provides ingestion-based statistics regarding the specified sensor with respect to\n various validation types, such as whether data exists, the number and percentage of missing\n values, and the number and percentage of duplicate timestamps.
" - } - }, - "NextToken": { - "target": "com.amazonaws.lookoutequipment#NextToken", - "traits": { - "smithy.api#documentation": "An opaque pagination token indicating where to continue the listing of sensor\n statistics.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Lists all the tags for a specified resource, including key and value.
" - } - }, - "com.amazonaws.lookoutequipment#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutequipment#AmazonResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource (such as the dataset or model) that is\n the focus of the ListTagsForResource operation.
Any tags associated with the resource.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 500 - } - } - }, - "com.amazonaws.lookoutequipment#MissingCompleteSensorData": { - "type": "structure", - "members": { - "AffectedSensorCount": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the number of sensors that have data missing completely.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information on sensors that have sensor data completely missing.\n
" - } - }, - "com.amazonaws.lookoutequipment#MissingSensorData": { - "type": "structure", - "members": { - "AffectedSensorCount": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the number of sensors that have atleast some data missing.
", - "smithy.api#required": {} - } - }, - "TotalNumberOfMissingValues": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the total number of missing values across all the sensors.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises aggregated information on sensors having missing data.
" - } - }, - "com.amazonaws.lookoutequipment#ModelArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+$" - } - }, - "com.amazonaws.lookoutequipment#ModelMetrics": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50000 - } - } - }, - "com.amazonaws.lookoutequipment#ModelName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z_-]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#ModelStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IMPORT_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.lookoutequipment#ModelSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#ModelSummary" - } - }, - "com.amazonaws.lookoutequipment#ModelSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model.
" - } - }, - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the dataset being used for the ML model.
" - } - }, - "DatasetArn": { - "target": "com.amazonaws.lookoutequipment#DatasetArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset used to create the model.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#ModelStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the ML model.
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time at which the specific model was created.
" - } - }, - "ActiveModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The model version that the inference scheduler uses to run an inference\n execution.
" - } - }, - "ActiveModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version that is set as active. The active model version \n is the model version that the inference scheduler uses to run an inference\n execution.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about the specified ML model, including dataset and model names and\n ARNs, as well as status.
" - } - }, - "com.amazonaws.lookoutequipment#ModelVersion": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.lookoutequipment#ModelVersionArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+\\/.+\\/model-version\\/[0-9]{1,}$" - } - }, - "com.amazonaws.lookoutequipment#ModelVersionSourceType": { - "type": "enum", - "members": { - "TRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRAINING" - } - }, - "RETRAINING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETRAINING" - } - }, - "IMPORT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT" - } - } - } - }, - "com.amazonaws.lookoutequipment#ModelVersionStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IMPORT_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPORT_IN_PROGRESS" - } - }, - "CANCELED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELED" - } - } - } - }, - "com.amazonaws.lookoutequipment#ModelVersionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#ModelVersionSummary" - } - }, - "com.amazonaws.lookoutequipment#ModelVersionSummary": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the model that this model version is a version of.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model that this model version is a version of.
" - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The version of the model.
" - } - }, - "ModelVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the model version.
" - } - }, - "CreatedAt": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "The time when this model version was created.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#ModelVersionStatus", - "traits": { - "smithy.api#documentation": "The current status of the model version.
" - } - }, - "SourceType": { - "target": "com.amazonaws.lookoutequipment#ModelVersionSourceType", - "traits": { - "smithy.api#documentation": "Indicates how this model version was generated.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about the specific model version.
" - } - }, - "com.amazonaws.lookoutequipment#MonotonicValues": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", - "traits": { - "smithy.api#documentation": "Indicates whether there is a potential data issue related to having monotonic values.\n
", - "smithy.api#required": {} - } - }, - "Monotonicity": { - "target": "com.amazonaws.lookoutequipment#Monotonicity", - "traits": { - "smithy.api#documentation": "Indicates the monotonicity of values. Can be INCREASING, DECREASING, or STATIC.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information on monotonic values in the data.
" - } - }, - "com.amazonaws.lookoutequipment#Monotonicity": { - "type": "enum", - "members": { - "DECREASING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DECREASING" - } - }, - "INCREASING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCREASING" - } - }, - "STATIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATIC" - } - } - } - }, - "com.amazonaws.lookoutequipment#MultipleOperatingModes": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.lookoutequipment#StatisticalIssueStatus", - "traits": { - "smithy.api#documentation": "Indicates whether there is a potential data issue related to having multiple operating\n modes.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information on operating modes in data.
" - } - }, - "com.amazonaws.lookoutequipment#NameOrArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" - } - }, - "com.amazonaws.lookoutequipment#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 8192 - }, - "smithy.api#pattern": "^\\p{ASCII}{0,8192}$" - } - }, - "com.amazonaws.lookoutequipment#OffCondition": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.lookoutequipment#Policy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20000 - }, - "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.lookoutequipment#PolicyRevisionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - }, - "smithy.api#pattern": "^[0-9A-Fa-f]+$" - } - }, - "com.amazonaws.lookoutequipment#PutResourcePolicy": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#PutResourcePolicyRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#PutResourcePolicyResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates a resource control policy for a given resource.
" - } - }, - "com.amazonaws.lookoutequipment#PutResourcePolicyRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutequipment#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the \n policy is being created.
", - "smithy.api#required": {} - } - }, - "ResourcePolicy": { - "target": "com.amazonaws.lookoutequipment#Policy", - "traits": { - "smithy.api#documentation": "The JSON-formatted resource policy to create.
", - "smithy.api#required": {} - } - }, - "PolicyRevisionId": { - "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", - "traits": { - "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. \n If you do not set the client request token, Amazon Lookout for Equipment \n generates one.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#PutResourcePolicyResponse": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutequipment#ResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which the \n policy was created.
" - } - }, - "PolicyRevisionId": { - "target": "com.amazonaws.lookoutequipment#PolicyRevisionId", - "traits": { - "smithy.api#documentation": "A unique identifier for a revision of the resource policy.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:.+$" - } - }, - "com.amazonaws.lookoutequipment#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The resource requested could not be found. Verify the resource ID and retry your\n request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.lookoutequipment#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" - } - }, - "com.amazonaws.lookoutequipment#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,1024}[^/]$" - } - }, - "com.amazonaws.lookoutequipment#S3Object": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.lookoutequipment#S3Bucket", - "traits": { - "smithy.api#documentation": "The name of the specific S3 bucket.
", - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.lookoutequipment#S3Key", - "traits": { - "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS key) key being used to encrypt the S3 object.\n Without this key, data in the bucket is not accessible.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Contains information about an S3 bucket.
" - } - }, - "com.amazonaws.lookoutequipment#S3Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^(^$)|([\\u0009\\u000A\\u000D\\u0020-\\u00FF]{1,1023}/$)$" - } - }, - "com.amazonaws.lookoutequipment#SensorName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - }, - "smithy.api#pattern": "^[0-9a-zA-Z:#$.\\-_]{1,200}$" - } - }, - "com.amazonaws.lookoutequipment#SensorStatisticsSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#SensorStatisticsSummary" - } - }, - "com.amazonaws.lookoutequipment#SensorStatisticsSummary": { - "type": "structure", - "members": { - "ComponentName": { - "target": "com.amazonaws.lookoutequipment#ComponentName", - "traits": { - "smithy.api#documentation": "Name of the component to which the particular sensor belongs for which the statistics\n belong to.
" - } - }, - "SensorName": { - "target": "com.amazonaws.lookoutequipment#SensorName", - "traits": { - "smithy.api#documentation": "Name of the sensor that the statistics belong to.
" - } - }, - "DataExists": { - "target": "com.amazonaws.lookoutequipment#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Parameter that indicates whether data exists for the sensor that the statistics belong\n to.
" - } - }, - "MissingValues": { - "target": "com.amazonaws.lookoutequipment#CountPercent", - "traits": { - "smithy.api#documentation": "Parameter that describes the total number of, and percentage of, values that are\n missing for the sensor that the statistics belong to.
" - } - }, - "InvalidValues": { - "target": "com.amazonaws.lookoutequipment#CountPercent", - "traits": { - "smithy.api#documentation": "Parameter that describes the total number of, and percentage of, values that are\n invalid for the sensor that the statistics belong to.
" - } - }, - "InvalidDateEntries": { - "target": "com.amazonaws.lookoutequipment#CountPercent", - "traits": { - "smithy.api#documentation": "Parameter that describes the total number of invalid date entries associated with the\n sensor that the statistics belong to.
" - } - }, - "DuplicateTimestamps": { - "target": "com.amazonaws.lookoutequipment#CountPercent", - "traits": { - "smithy.api#documentation": "Parameter that describes the total number of duplicate timestamp records associated\n with the sensor that the statistics belong to.
" - } - }, - "CategoricalValues": { - "target": "com.amazonaws.lookoutequipment#CategoricalValues", - "traits": { - "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n is categorical.
" - } - }, - "MultipleOperatingModes": { - "target": "com.amazonaws.lookoutequipment#MultipleOperatingModes", - "traits": { - "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n has more than one operating mode.
" - } - }, - "LargeTimestampGaps": { - "target": "com.amazonaws.lookoutequipment#LargeTimestampGaps", - "traits": { - "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n contains one or more large gaps between consecutive timestamps.
" - } - }, - "MonotonicValues": { - "target": "com.amazonaws.lookoutequipment#MonotonicValues", - "traits": { - "smithy.api#documentation": "Parameter that describes potential risk about whether data associated with the sensor\n is mostly monotonic.
" - } - }, - "DataStartTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference to indicate the beginning of valid data associated with\n the sensor that the statistics belong to.
" - } - }, - "DataEndTime": { - "target": "com.amazonaws.lookoutequipment#Timestamp", - "traits": { - "smithy.api#documentation": "Indicates the time reference to indicate the end of valid data associated with the\n sensor that the statistics belong to.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Summary of ingestion statistics like whether data exists, number of missing values,\n number of invalid values and so on related to the particular sensor.
" - } - }, - "com.amazonaws.lookoutequipment#SensorsWithShortDateRange": { - "type": "structure", - "members": { - "AffectedSensorCount": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the number of sensors that have less than 90 days of data.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information on sensors that have shorter date range.
" - } - }, - "com.amazonaws.lookoutequipment#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Resource limitations have been exceeded.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.lookoutequipment#StartDataIngestionJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#StartDataIngestionJobRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#StartDataIngestionJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.\n
" - } - }, - "com.amazonaws.lookoutequipment#StartDataIngestionJobRequest": { - "type": "structure", - "members": { - "DatasetName": { - "target": "com.amazonaws.lookoutequipment#DatasetIdentifier", - "traits": { - "smithy.api#documentation": "The name of the dataset being used by the data ingestion job.
", - "smithy.api#required": {} - } - }, - "IngestionInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#IngestionInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies information for the input data for the data ingestion job, including dataset\n S3 location.
", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the data ingestion job.
", - "smithy.api#required": {} - } - }, - "ClientToken": { - "target": "com.amazonaws.lookoutequipment#IdempotenceToken", - "traits": { - "smithy.api#documentation": "A unique identifier for the request. If you do not set the client request token, Amazon\n Lookout for Equipment generates one.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#StartDataIngestionJobResponse": { - "type": "structure", - "members": { - "JobId": { - "target": "com.amazonaws.lookoutequipment#IngestionJobId", - "traits": { - "smithy.api#documentation": "Indicates the job ID of the data ingestion job.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#IngestionJobStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the StartDataIngestionJob operation.
Starts an inference scheduler.
" - } - }, - "com.amazonaws.lookoutequipment#StartInferenceSchedulerRequest": { - "type": "structure", - "members": { - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler to be started.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#StartInferenceSchedulerResponse": { - "type": "structure", - "members": { - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model being used by the inference scheduler.\n
" - } - }, - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model being used by the inference scheduler.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler being started.
" - } - }, - "InferenceSchedulerArn": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference scheduler being started.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the inference scheduler.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#StatisticalIssueStatus": { - "type": "enum", - "members": { - "POTENTIAL_ISSUE_DETECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POTENTIAL_ISSUE_DETECTED" - } - }, - "NO_ISSUE_DETECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_ISSUE_DETECTED" - } - } - } - }, - "com.amazonaws.lookoutequipment#StopInferenceScheduler": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#StopInferenceSchedulerRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#StopInferenceSchedulerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Stops an inference scheduler.
" - } - }, - "com.amazonaws.lookoutequipment#StopInferenceSchedulerRequest": { - "type": "structure", - "members": { - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler to be stopped.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#StopInferenceSchedulerResponse": { - "type": "structure", - "members": { - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ML model used by the inference scheduler being\n stopped.
" - } - }, - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the ML model used by the inference scheduler being stopped.
" - } - }, - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerName", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler being stopped.
" - } - }, - "InferenceSchedulerArn": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inference schedule being stopped.
" - } - }, - "Status": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerStatus", - "traits": { - "smithy.api#documentation": "Indicates the status of the inference scheduler.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#SynthesizedJsonInlineDataSchema": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000000 - }, - "smithy.api#mediaType": "application/json" - } - }, - "com.amazonaws.lookoutequipment#SynthesizedJsonModelMetrics": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50000 - }, - "smithy.api#mediaType": "application/json" - } - }, - "com.amazonaws.lookoutequipment#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.lookoutequipment#TagKey", - "traits": { - "smithy.api#documentation": "The key for the specified tag.
", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.lookoutequipment#TagValue", - "traits": { - "smithy.api#documentation": "The value for the specified tag.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "A tag is a key-value pair that can be added to a resource as metadata.
" - } - }, - "com.amazonaws.lookoutequipment#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.lookoutequipment#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.lookoutequipment#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.lookoutequipment#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.lookoutequipment#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Associates a given tag to a resource in your account. A tag is a key-value pair which\n can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for\n organizing your resources as well as helping you to search and filter by tag. Multiple tags\n can be added to a resource, either when you create it, or later. Up to 50 tags can be\n associated with each resource.
" - } - }, - "com.amazonaws.lookoutequipment#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutequipment#AmazonResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specific resource to which the tag should be\n associated.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.lookoutequipment#TagList", - "traits": { - "smithy.api#documentation": "The tag or tags to be associated with a specific resource. Both the tag key and value\n are specified.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" - } - }, - "com.amazonaws.lookoutequipment#TargetSamplingRate": { - "type": "enum", - "members": { - "PT1S": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT1S" - } - }, - "PT5S": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT5S" - } - }, - "PT10S": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT10S" - } - }, - "PT15S": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT15S" - } - }, - "PT30S": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT30S" - } - }, - "PT1M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT1M" - } - }, - "PT5M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT5M" - } - }, - "PT10M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT10M" - } - }, - "PT15M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT15M" - } - }, - "PT30M": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT30M" - } - }, - "PT1H": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PT1H" - } - } - } - }, - "com.amazonaws.lookoutequipment#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The request was denied due to request throttling.
", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.lookoutequipment#TimeZoneOffset": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(\\+|\\-)[0-9]{2}\\:[0-9]{2}$" - } - }, - "com.amazonaws.lookoutequipment#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.lookoutequipment#UnsupportedTimestamps": { - "type": "structure", - "members": { - "TotalNumberOfUnsupportedTimestamps": { - "target": "com.amazonaws.lookoutequipment#Integer", - "traits": { - "smithy.api#documentation": "Indicates the total number of unsupported timestamps across the ingested data.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Entity that comprises information abount unsupported timestamps in the dataset.
" - } - }, - "com.amazonaws.lookoutequipment#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Removes a specific tag from a given resource. The tag is specified by its key.
" - } - }, - "com.amazonaws.lookoutequipment#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.lookoutequipment#AmazonResourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which the tag is currently associated.\n
", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.lookoutequipment#TagKeyList", - "traits": { - "smithy.api#documentation": "Specifies the key of the tag to be removed from a specified resource.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#UpdateActiveModelVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest" - }, - "output": { - "target": "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Sets the active model version for a given machine learning model.
" - } - }, - "com.amazonaws.lookoutequipment#UpdateActiveModelVersionRequest": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the machine learning model for which the active model version \n is being set.
", - "smithy.api#required": {} - } - }, - "ModelVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The version of the machine learning model for which the active model version \n is being set.
", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#UpdateActiveModelVersionResponse": { - "type": "structure", - "members": { - "ModelName": { - "target": "com.amazonaws.lookoutequipment#ModelName", - "traits": { - "smithy.api#documentation": "The name of the machine learning model for which the active model version was set.
" - } - }, - "ModelArn": { - "target": "com.amazonaws.lookoutequipment#ModelArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model for which \n the active model version was set.
" - } - }, - "CurrentActiveVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The version that is currently active of the machine learning model \n for which the active model version was set.
" - } - }, - "PreviousActiveVersion": { - "target": "com.amazonaws.lookoutequipment#ModelVersion", - "traits": { - "smithy.api#documentation": "The previous version that was active of the machine learning model \n for which the active model version was set.
" - } - }, - "CurrentActiveVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that is the\n current active model version.
" - } - }, - "PreviousActiveVersionArn": { - "target": "com.amazonaws.lookoutequipment#ModelVersionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the machine learning model version that was the\n previous active model version.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.lookoutequipment#UpdateInferenceScheduler": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#UpdateInferenceSchedulerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Updates an inference scheduler.
" - } - }, - "com.amazonaws.lookoutequipment#UpdateInferenceSchedulerRequest": { - "type": "structure", - "members": { - "InferenceSchedulerName": { - "target": "com.amazonaws.lookoutequipment#InferenceSchedulerIdentifier", - "traits": { - "smithy.api#documentation": "The name of the inference scheduler to be updated.
", - "smithy.api#required": {} - } - }, - "DataDelayOffsetInMinutes": { - "target": "com.amazonaws.lookoutequipment#DataDelayOffsetInMinutes", - "traits": { - "smithy.api#documentation": "A period of time (in minutes) by which inference on the data is delayed after the data\n starts. For instance, if you select an offset delay time of five minutes, inference will\n not begin on the data until the first data measurement after the five minute mark. For\n example, if five minutes is selected, the inference scheduler will wake up at the\n configured frequency with the additional five minute delay time to check the customer S3\n bucket. The customer can upload data at the same frequency and they don't need to stop and\n restart the scheduler when uploading new data.
" - } - }, - "DataUploadFrequency": { - "target": "com.amazonaws.lookoutequipment#DataUploadFrequency", - "traits": { - "smithy.api#documentation": "How often data is uploaded to the source S3 bucket for the input data. The value chosen\n is the length of time between data uploads. For instance, if you select 5 minutes, Amazon\n Lookout for Equipment will upload the real-time data to the source bucket once every 5\n minutes. This frequency also determines how often Amazon Lookout for Equipment starts a\n scheduled inference on your data. In this example, it starts once every 5 minutes.
" - } - }, - "DataInputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceInputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies information for the input data for the inference scheduler, including\n delimiter, format, and dataset location.
" - } - }, - "DataOutputConfiguration": { - "target": "com.amazonaws.lookoutequipment#InferenceOutputConfiguration", - "traits": { - "smithy.api#documentation": "Specifies information for the output results from the inference scheduler, including\n the output S3 location.
" - } - }, - "RoleArn": { - "target": "com.amazonaws.lookoutequipment#IamRoleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a role with permission to access the data source for\n the inference scheduler.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#UpdateLabelGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.lookoutequipment#AccessDeniedException" - }, - { - "target": "com.amazonaws.lookoutequipment#ConflictException" - }, - { - "target": "com.amazonaws.lookoutequipment#InternalServerException" - }, - { - "target": "com.amazonaws.lookoutequipment#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lookoutequipment#ThrottlingException" - }, - { - "target": "com.amazonaws.lookoutequipment#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n Updates the label group.\n
" - } - }, - "com.amazonaws.lookoutequipment#UpdateLabelGroupRequest": { - "type": "structure", - "members": { - "LabelGroupName": { - "target": "com.amazonaws.lookoutequipment#LabelGroupName", - "traits": { - "smithy.api#documentation": "\n The name of the label group to be updated.\n
", - "smithy.api#required": {} - } - }, - "FaultCodes": { - "target": "com.amazonaws.lookoutequipment#FaultCodes", - "traits": { - "smithy.api#documentation": "\n Updates the code indicating the type of anomaly associated with the label.\n
\nData in this field will be retained for service usage. Follow best practices for the security of your data.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.lookoutequipment#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.lookoutequipment#BoundedLengthString", - "traits": { - "smithy.api#required": {} - } } - }, - "traits": { - "smithy.api#documentation": "The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a\n related Amazon Web Services service that's being utilized.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } } - } -} \ No newline at end of file +}